cdnca

API reference

/v1/admin/entitlement

1 operations

← All groups · First call? Read the tutorial: auth, permissions, requests and responses, common failures

MethodPathSummaryAuth
POST/v1/admin/entitlement/refreshRefresh the locally verified entitlement leaseSession

Contract file：api/control-entitlement-refresh.openapi.yaml

Operation details

POST /v1/admin/entitlement/refresh

Refresh the locally verified entitlement lease

operationId
refreshAdminEntitlement
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：platform.admin

Description (from the contract)

Requires a live platform administrator session. The control plane contacts the configured license service, verifies the signed lease, and atomically installs it locally. Existing edge traffic does not depend on this request or on license-service availability.

Parameters

refreshAdminEntitlement Parameters
NameInTypeRequiredDescription
X-Request-IDheaderstringYes—
Idempotency-KeyheaderstringYes—

Request body

application/json · Required：Yes

Responses

refreshAdminEntitlement Responses
StatusDescription
200The signed lease was verified and installed.

Fields：schema: string request_id: string snapshot: object

400Stable API error.
401Stable API error.
403Stable API error.
409Stable API error.
502Stable API error.
503Stable API error.
504Stable API error.

What to do on failure

  • 400 Fix the parameters or body per the field list; do not retry unchanged.
  • 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.
  • 409 Read the current state first; a retry of the same operation keeps the original Idempotency-Key and body.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list