MethodPathSummaryAuth
GET/v1/cc-rule-groups—Session
GET/v1/cc-rule-groups/summaryCC rule group pill counts over every groupSession

Contract file:api/control-openresty-security.openapi.yaml

Operation details

GET /v1/cc-rule-groups

operationId
listCCRuleGroupsForOpenRestyConfig
Auth
  • Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
Required permissions

All of:openresty_security.read

Responses

listCCRuleGroupsForOpenRestyConfig Responses
StatusDescription
200System groups are identified by system_rule_key, falling back to system_rule_id for legacy projections. Custom policy groups retain their UUID IDs.
401Authentication required
403Permission denied

What to do on failure

  • 401 Check the credential format and whether it expired or was rotated.
  • 403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.

↑ Back to list

GET /v1/cc-rule-groups/summary

CC rule group pill counts over every group

operationId
summarizeCCRuleGroups
Auth
  • Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
Required permissions

All of:openresty_security.read

Description (from the contract)

System groups count from the signed rule catalog once it has synced, else from the per-tenant projection; custom groups are the scope's CC policies. visible/disabled are enabled/disabled groups of both kinds.

Responses

summarizeCCRuleGroups Responses
StatusDescription
200Counts.

Fields:all: integer system: integer custom: integer visible: integer disabled: integer

401Authentication required
403Permission denied

What to do on failure

  • 401 Check the credential format and whether it expired or was rotated.
  • 403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.

↑ Back to list