ACL Profiles

Get ACL Profiles

get

Get all ACL Profiles in a configuration

Path parameters
configstringRequired
Responses
200
ACL Profiles retrieved successfully
application/json
get
GET /api/v4.0/conf/{config}/acl-profiles HTTP/1.1
Host: 
Accept: */*

{
  "total": 1,
  "items": [
    {
      "action": "text",
      "allow": [
        "text"
      ],
      "allow_bot": [
        "text"
      ],
      "deny": [
        "text"
      ],
      "deny_bot": [
        "text"
      ],
      "description": "text",
      "force_deny": [
        "text"
      ],
      "id": "text",
      "name": "text",
      "passthrough": [
        "text"
      ],
      "tags": [
        "text"
      ]
    }
  ]
}

Modify ACL Profiles

put

Updates an existing set of ACL Profiles for a configuration

Path parameters
configstringRequired
Bodyobject · ACLProfile[]
actionstringOptional
allowstring[]Optional
allow_botstring[]Optional
denystring[]Optional
deny_botstring[]Optional
descriptionstringOptional
force_denystring[]Optional
idstringRequired
namestringRequired
passthroughstring[]Optional
tagsstring[]Optional
Responses
200
ACL Profiles updated successfully
application/json
put
PUT /api/v4.0/conf/{config}/acl-profiles HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 201

[
  {
    "action": "text",
    "allow": [
      "text"
    ],
    "allow_bot": [
      "text"
    ],
    "deny": [
      "text"
    ],
    "deny_bot": [
      "text"
    ],
    "description": "text",
    "force_deny": [
      "text"
    ],
    "id": "text",
    "name": "text",
    "passthrough": [
      "text"
    ],
    "tags": [
      "text"
    ]
  }
]
{
  "message": "Successfully updated entry"
}

Create ACL Profiles

post

Create a complete set of ACL Profiles for a configuration

Path parameters
configstringRequired
Bodyobject · ACLProfile[]
actionstringOptional
allowstring[]Optional
allow_botstring[]Optional
denystring[]Optional
deny_botstring[]Optional
descriptionstringOptional
force_denystring[]Optional
idstringRequired
namestringRequired
passthroughstring[]Optional
tagsstring[]Optional
Responses
201
ACL Profiles created successfully
application/json
post
POST /api/v4.0/conf/{config}/acl-profiles HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 201

[
  {
    "action": "text",
    "allow": [
      "text"
    ],
    "allow_bot": [
      "text"
    ],
    "deny": [
      "text"
    ],
    "deny_bot": [
      "text"
    ],
    "description": "text",
    "force_deny": [
      "text"
    ],
    "id": "text",
    "name": "text",
    "passthrough": [
      "text"
    ],
    "tags": [
      "text"
    ]
  }
]
{
  "message": "Successfully created entry"
}

Delete ACL Profiles

delete

Delete all ACL Profiles in a configuration

Path parameters
configstringRequired
Responses
200
ACL Profiles deleted successfully
application/json
delete
DELETE /api/v4.0/conf/{config}/acl-profiles HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get single ACL Profile

get

Get an individual ACL Profile (not the entire set) from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200
ACL Profile retrieved successfully
application/json
get
GET /api/v4.0/conf/{config}/acl-profiles/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "action": "text",
  "allow": [
    "text"
  ],
  "allow_bot": [
    "text"
  ],
  "deny": [
    "text"
  ],
  "deny_bot": [
    "text"
  ],
  "description": "text",
  "force_deny": [
    "text"
  ],
  "id": "text",
  "name": "text",
  "passthrough": [
    "text"
  ],
  "tags": [
    "text"
  ]
}

Modify a single ACL Profile

put

Update an individual ACL Profile within a configuration

Path parameters
configstringRequired
entry_idstringRequired
Body
actionstringOptional
allowstring[]Optional
allow_botstring[]Optional
denystring[]Optional
deny_botstring[]Optional
descriptionstringOptional
force_denystring[]Optional
idstringRequired
namestringRequired
passthroughstring[]Optional
tagsstring[]Optional
Responses
200
ACL Profile updated successfully
application/json
put
PUT /api/v4.0/conf/{config}/acl-profiles/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 199

{
  "action": "text",
  "allow": [
    "text"
  ],
  "allow_bot": [
    "text"
  ],
  "deny": [
    "text"
  ],
  "deny_bot": [
    "text"
  ],
  "description": "text",
  "force_deny": [
    "text"
  ],
  "id": "text",
  "name": "text",
  "passthrough": [
    "text"
  ],
  "tags": [
    "text"
  ]
}
{
  "message": "Successfully updated entry"
}

Create single ACL Profile

post

Create an individual ACL Profile within a configuration

Path parameters
configstringRequired
entry_idstringRequired
Body
actionstringOptional
allowstring[]Optional
allow_botstring[]Optional
denystring[]Optional
deny_botstring[]Optional
descriptionstringOptional
force_denystring[]Optional
idstringRequired
namestringRequired
passthroughstring[]Optional
tagsstring[]Optional
Responses
201
ACL Profile created successfully
application/json
post
POST /api/v4.0/conf/{config}/acl-profiles/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 199

{
  "action": "text",
  "allow": [
    "text"
  ],
  "allow_bot": [
    "text"
  ],
  "deny": [
    "text"
  ],
  "deny_bot": [
    "text"
  ],
  "description": "text",
  "force_deny": [
    "text"
  ],
  "id": "text",
  "name": "text",
  "passthrough": [
    "text"
  ],
  "tags": [
    "text"
  ]
}
{
  "message": "Successfully created entry"
}

Delete single ACL Profile

delete

Delete an individual ACL Profile (not the entire set) from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200
ACL Profile deleted successfully
application/json
delete
DELETE /api/v4.0/conf/{config}/acl-profiles/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get ACL Profiles version list

get

Get list of versions of ACL Profiles in a configuration

Path parameters
configstringRequired
Responses
200
ACL Profiles version list retrieved successfully
application/json
get
GET /api/v4.0/conf/{config}/acl-profiles/versions HTTP/1.1
Host: 
Accept: */*

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "[email protected]",
      "message": "text",
      "date": "2025-07-12T00:49:04.185Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Get version of ACL Profile

get

Get a specific version of an ACL Profile

Path parameters
configstringRequired
versionstringRequired
Responses
200
ACL Profile retrieved successfully
application/json
get
GET /api/v4.0/conf/{config}/acl-profiles/versions/{version} HTTP/1.1
Host: 
Accept: */*

{
  "total": 1,
  "items": [
    {
      "action": "text",
      "allow": [
        "text"
      ],
      "allow_bot": [
        "text"
      ],
      "deny": [
        "text"
      ],
      "deny_bot": [
        "text"
      ],
      "description": "text",
      "force_deny": [
        "text"
      ],
      "id": "text",
      "name": "text",
      "passthrough": [
        "text"
      ],
      "tags": [
        "text"
      ]
    }
  ]
}

Revert an ACL Profile to the specified version

put

Set a previous ACL Profile version to be the current one

Path parameters
configstringRequired
versionstringRequired
Responses
200
ACL Profile reversion was successful
application/json
put
PUT /api/v4.0/conf/{config}/acl-profiles/versions/{version}/revert HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully updated entry"
}
PreviousNamespace referenceNextActions

Last updated

Was this helpful?