cdnca

API reference

/v1/modules

1 operations

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

MethodPathSummaryAuth
GET/v1/modulesList the module, pack and theme feature codes the local entitlement lease grantsSession

Contract file：api/openapi/v1/control.yaml

Operation details

GET /v1/modules

List the module, pack and theme feature codes the local entitlement lease grants

operationId
listGrantedModules
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

The contract has no separate permission annotation; see the description below and the 403 response.

Description (from the contract)

Any authenticated session. Modules is empty unless the verified local lease is valid (grace included is not valid), matching the API entry gate (entitlement_feature_denied) and the publication gate. Front-end menu items with requiredModule are shown only when the code is listed.

Responses

listGrantedModules Responses
StatusDescription
200Granted module codes.

Fields：status: string lease_serial: integer modules: array<string>

401Authentication failed or the session is invalid.
500The request could not be completed because of an internal failure.

What to do on failure

  • 401 Check the credential format and whether it expired or was rotated.
  • 500 Outcome unknown: read back by ID or list first, then decide whether to retry with the original Idempotency-Key.

↑ Back to list