Version 2.1.1792967583 · latest Download OpenAPI Markdown

CC rules

Ordered combinations of matchers and filters; a site can pick one rule group.

cc-rulesProtectionAuthentication: User (some parameters admin only)6 endpoints

List CC rule groups

GET/api/v2/cc-rules

Authentication: User (some parameters admin only)

Query parameters

Field	Type	Required	Description
page	integer	—	Page number, starting from 1 Default `1`
page_size	integer	—	Items per page Default `20`
sort	string	—	Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`
tenant_id	integer	—	Admin only: filter by tenant. 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. Values `["platform","tenant"]`

Create CC rule group

POST/api/v2/cc-rules

Authentication: User (some parameters admin only)

Request body application/json

Field	Type	Required	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 Default `true`
items	CcRuleItem[]	Required	Rule items, executed in order; the count is limited by the setting protect.cc_rule_items_max.
name	string	Required	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. Default `true`

Batch enable or disable CC rule groups

POST/api/v2/cc-rules/batch-enable

Authentication: User (some parameters admin only)

Request body application/json

Field	Type	Required	Description
enabled	boolean	Required	Whether enabled Default `true`
ids	integer[]	Required	IDs of the objects to change, at most 100.

Get CC rule group

GET/api/v2/cc-rules/{id}

Authentication: User (some parameters admin only)

Update CC rule group

PUT/api/v2/cc-rules/{id}

Authentication: User (some parameters admin only)

Request body application/json

Field	Type	Required	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 Default `true`
items	CcRuleItem[]	Required	Rule items, executed in order; the count is limited by the setting protect.cc_rule_items_max.
name	string	Required	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. Default `true`

Delete CC rule group

DELETE/api/v2/cc-rules/{id}

Authentication: User (some parameters admin only)

CC rules object

Field	Type	Required	Description
builtin	boolean	—	Built-in object; cannot be deleted. read-only
created_at	string	—	Created at read-only
des	string	—	Remark; empty if omitted (omitting it on update also clears it, since the update replaces the whole object).
enabled	boolean	—	Whether enabled Default `true`
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).
id	integer	—	Record ID read-only
ids	integer[]	Required	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). read-only
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). read-only
updated	integer[]	—	IDs that were set (including those already in the target state), in request order.
updated_at	string	—	Updated at read-only
visible	boolean	—	Shown in the site's rule group drop-down. Default `true`

curl

# List CC rule groups
curl "https://panel.example.com/api/v2/cc-rules" \
  -H "X-API-Key: $GOCDN_API_KEY"

# Create CC rule group
curl -X POST "https://panel.example.com/api/v2/cc-rules" \
  -H "X-API-Key: $GOCDN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"items":[{"action":"ban","filter_ids":[8],"match_id":3}],"name":"js"}'

# Batch enable or disable CC rule groups
curl -X POST "https://panel.example.com/api/v2/cc-rules/batch-enable" \
  -H "X-API-Key: $GOCDN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":false,"ids":[1,2]}'

# Get CC rule group
curl "https://panel.example.com/api/v2/cc-rules/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY"

# Update CC rule group
curl -X PUT "https://panel.example.com/api/v2/cc-rules/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"items":[{"action":"ban","filter_ids":[8],"match_id":3}],"name":"js"}'

# Delete CC rule group
curl -X DELETE "https://panel.example.com/api/v2/cc-rules/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY"