ACL Profiles
Get all ACL Profiles in a configuration
ACL Profiles retrieved successfully
Validation Error
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"
]
}
]
}
Updates an existing set of ACL Profiles for a configuration
ACL Profiles updated successfully
Validation Error
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 a complete set of ACL Profiles for a configuration
ACL Profiles created successfully
Validation Error
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 all ACL Profiles in a configuration
ACL Profiles deleted successfully
Validation Error
DELETE /api/v4.0/conf/{config}/acl-profiles HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}
Get an individual ACL Profile (not the entire set) from the specified configuration
ACL Profile retrieved successfully
Validation Error
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"
]
}
Update an individual ACL Profile within a configuration
ACL Profile updated successfully
Validation Error
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 an individual ACL Profile within a configuration
ACL Profile created successfully
Validation Error
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 an individual ACL Profile (not the entire set) from the specified configuration
ACL Profile deleted successfully
Validation Error
DELETE /api/v4.0/conf/{config}/acl-profiles/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}
Get list of versions of ACL Profiles in a configuration
ACL Profiles version list retrieved successfully
Validation Error
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-08-29T18:58:23.439Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}
Get a specific version of an ACL Profile
ACL Profile retrieved successfully
Validation Error
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"
]
}
]
}
Set a previous ACL Profile version to be the current one
ACL Profile reversion was successful
Validation Error
PUT /api/v4.0/conf/{config}/acl-profiles/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}
Last updated
Was this helpful?