CC rules cc-rules
Ordered combinations of matchers and filters; a site can pick one rule group.
Pick an endpoint to see its example call on the right.
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.
/api/v2/cc-rulesList CC rule groups
Authentication: User (some parameters admin only)
Query parameters
| Field | Type | Description |
|---|---|---|
page | integer | Page number, starting from 1 |
page_size | integer | Items per page |
sort | string | Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id` |
tenant_id | integer | Admin only: filter by tenant (a malformed value returns 422). Ignored for tenant credentials, which only see their own tenant's data |
enabled | boolean | Filter by enabled state. |
name | string | Filter by name substring. |
owner | string | platform = platform objects only; tenant = tenant objects only. |
/api/v2/cc-rulesCreate CC rule group
Authentication: User (some parameters admin only)
Request body application/json
| Field | Type | Description |
|---|---|---|
des | string | Remark; empty if omitted (omitting it on update also clears it, since the update replaces the whole object). |
enabled | boolean | Whether enabled |
expected_updated_at | string | Optimistic lock, update only - the updated_at as the caller read it. If it differs from the stored one, 409 stale_version is returned and nothing is saved; omit to skip the check. Ignored on create. |
itemsRequired | CcRuleItem[] | Rule items, executed in order; the count is limited by the setting protect.cc_rule_items_max. |
nameRequired | string | Name |
show_to | integer[] | Tenants that can see a platform rule group; empty = visible to all tenants, otherwise only the listed tenants can see it and select it as a site's cc_level. Returned to admins only. |
sort | integer | Panel sort order (smaller first). |
tenant_id | integer | Owning tenant; null = platform object (built-in or created by an admin, read-only for tenants). |
visible | boolean | Shown in the site's rule group drop-down. |
/api/v2/cc-rules/batch-enableBatch enable or disable CC rule groups
Authentication: User (some parameters admin only)
Request body application/json
| Field | Type | Description |
|---|---|---|
enabledRequired | boolean | Whether enabled |
idsRequired | integer[] | IDs of the objects to change, at most 100. |
/api/v2/cc-rules/{id}Get CC rule group
Authentication: User (some parameters admin only)
/api/v2/cc-rules/{id}Update CC rule group
Authentication: User (some parameters admin only)
Request body application/json
| Field | Type | Description |
|---|---|---|
des | string | Remark; empty if omitted (omitting it on update also clears it, since the update replaces the whole object). |
enabled | boolean | Whether enabled |
expected_updated_at | string | Optimistic lock, update only - the updated_at as the caller read it. If it differs from the stored one, 409 stale_version is returned and nothing is saved; omit to skip the check. Ignored on create. |
itemsRequired | CcRuleItem[] | Rule items, executed in order; the count is limited by the setting protect.cc_rule_items_max. |
nameRequired | string | Name |
show_to | integer[] | Tenants that can see a platform rule group; empty = visible to all tenants, otherwise only the listed tenants can see it and select it as a site's cc_level. Returned to admins only. |
sort | integer | Panel sort order (smaller first). |
tenant_id | integer | Owning tenant; null = platform object (built-in or created by an admin, read-only for tenants). |
visible | boolean | Shown in the site's rule group drop-down. |
/api/v2/cc-rules/{id}Delete CC rule group
Authentication: User (some parameters admin only)
CC rules object
| Field | Type | Description |
|---|---|---|
builtin | boolean | Built-in object; cannot be deleted. |
created_at | string | Created at |
des | string | Remark; empty if omitted (omitting it on update also clears it, since the update replaces the whole object). |
enabled | boolean | Whether enabled |
errors | FieldError[] | Why each remaining item was not changed; field is /ids/<index>, code as in the single-item update (not_found, readonly and so on). |
expected_updated_at | string | Optimistic lock, update only - the updated_at as the caller read it. If it differs from the stored one, 409 stale_version is returned and nothing is saved; omit to skip the check. Ignored on create. |
id | integer | Record ID |
idsRequired | integer[] | IDs of the objects to change, at most 100. |
items | CcRuleItem[] | Rule items, executed in order; the count is limited by the setting protect.cc_rule_items_max. |
name | string | Name |
ruleset_id | string | Compiled ruleset id: cc.level.<name> for platform groups (referenced by the site's cc_level and guard.default_cc_level); cc.user.r<id> for tenant groups (selectable as cc_level by the tenant's own sites; sites on a package need custom_cc_rule). |
show_to | integer[] | Tenants that can see a platform rule group; empty = visible to all tenants, otherwise only the listed tenants can see it and select it as a site's cc_level. Returned to admins only. |
sort | integer | Panel sort order (smaller first). |
tenant_id | integer | Owning tenant; null = platform object (built-in or created by an admin, read-only for tenants). |
updated | integer[] | IDs that were set (including those already in the target state), in request order. |
updated_at | string | Updated at |
visible | boolean | Shown in the site's rule group drop-down. |
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.
{
"id": 1,
"name": "example"
}{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"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"
}