Version 2.4.7.20261116085428 · latest

Access control lists acls

Rule sets that allow or block requests by IP/CIDR and other conditions; the platform provides built-in rules and tenants can create their own.

Pick an endpoint to see its example call on the right.

ProtectionAuthentication: User (some parameters admin only)6 endpoints

Authentication

Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.

X-API-Key

Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).

Conventions

Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.

Times are RFC 3339 (UTC); amounts are in cents.

Writes return 200/201/204 on success; duplicates of a unique key return 409.

GET/api/v2/aclsList ACLs

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
pageinteger Page number, starting from 1
Default 1
page_sizeinteger Items per page
Default 20
sortstring Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`
tenant_idinteger Admin only: filter by tenant (a malformed value returns 422). Ignored for tenant credentials, which only see their own tenant's data
tenant_idsstring Admin only: only these tenants, comma-separated positive integers, at most 200 after deduplication (more, or a malformed value, returns 422); a single ID works too. Filters only and does not switch the request scope; combined with tenant_id and other filters as an intersection. A tenant credential sending a non-empty value gets 403
enabledboolean Filter by enabled state.
namestring Filter by name substring.
ownerstring platform = platform objects only; tenant = tenant objects only.
Values ["platform","tenant"]
POST/api/v2/aclsCreate ACL

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
default_actionRequiredstring Action when no rule matches.
Values ["allow","deny"]
desstring Remark; empty if omitted (omitting it on update also clears it, since the update replaces the whole object).
enabledboolean Whether enabled
Default true
nameRequiredstring Name
rulesRequiredAclRule[] Matched in order; the count is limited by the setting protect.acl_rules_max.
tenant_idinteger Owning tenant; null = platform object (built-in or created by an admin, read-only for tenants).
POST/api/v2/acls/batch-enableBatch enable or disable ACLs

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
enabledRequiredboolean Whether enabled
Default true
idsRequiredinteger[] IDs of the objects to change, at most 100.
GET/api/v2/acls/{id}Get ACL

Authentication: User (some parameters admin only)

PUT/api/v2/acls/{id}Update ACL

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
default_actionRequiredstring Action when no rule matches.
Values ["allow","deny"]
desstring Remark; empty if omitted (omitting it on update also clears it, since the update replaces the whole object).
enabledboolean Whether enabled
Default true
nameRequiredstring Name
rulesRequiredAclRule[] Matched in order; the count is limited by the setting protect.acl_rules_max.
tenant_idinteger Owning tenant; null = platform object (built-in or created by an admin, read-only for tenants).
DELETE/api/v2/acls/{id}Delete ACL

Authentication: User (some parameters admin only)

Access control lists object

FieldTypeDescription
builtinboolean Built-in object; cannot be deleted.
read-only
created_atstring Created at
read-only
default_actionstring Action when no rule matches.
Values ["allow","deny"]
desstring Remark; empty if omitted (omitting it on update also clears it, since the update replaces the whole object).
enabledboolean Whether enabled
Default true
errorsFieldError[] Why each remaining item was not changed; field is /ids/<index>, code as in the single-item update (not_found, readonly and so on).
idinteger Record ID
read-only
idsRequiredinteger[] IDs of the objects to change, at most 100.
namestring Name
rulesAclRule[] Matched in order; the count is limited by the setting protect.acl_rules_max.
tenant_idinteger Owning tenant; null = platform object (built-in or created by an admin, read-only for tenants).
read-only
updatedinteger[] IDs that were set (including those already in the target state), in request order.
updated_atstring Updated at
read-only

Responses and errors

Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "code": "validation_failed",
  "detail": "Invalid request parameters",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name is required"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command