cdnca

API reference

/v1/site-rollouts

3 operations · 3 support API keys

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

MethodPathSummaryAuth
GET/v1/site-rolloutsList rollouts in the authenticated tenant scopeAPI keySession
GET/v1/site-rollouts/{rollout_id}Get rollout progress in the authenticated tenant scopeAPI keySession
GET/v1/site-rollouts/{rollout_id}/deploymentsList deployment progress without node target metadataAPI keySession

Contract file：api/control-site-publications.openapi.yaml

Operation details

GET /v1/site-rollouts

List rollouts in the authenticated tenant scope

operationId
listTenantSiteRollouts
Auth
  • API key: header Authorization: CdncaKey <key_id>.<secret>. Effective permissions are the key scopes intersected with the owner’s current permissions.
  • 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：sites.read

Parameters

listTenantSiteRollouts Parameters
NameInTypeRequiredDescription
limitqueryintegerNo—
cursorquerystringNoVersioned base64url HMAC-SHA256 envelope returned by the immediately preceding page. It is bound to audience, resolved tenant scope, resource kind, and the rollout ID for deployment pages. It cannot be reused across those boundaries or modified.

Responses

listTenantSiteRollouts Responses
StatusDescription
200Stable tenant rollout page.

Fields：items: array<TenantRollout> next_cursor?: string

400Invalid UUID, RFC3339 value, enum, cursor, header, query, or JSON body.
401Authentication is missing or invalid.
403Wrong audience, missing permission, or tenant scope override.
503Storage, signing, cancellation, response validation, or another internal dependency is unavailable.

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.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list

GET /v1/site-rollouts/{rollout_id}

Get rollout progress in the authenticated tenant scope

operationId
getTenantSiteRollout
Auth
  • API key: header Authorization: CdncaKey <key_id>.<secret>. Effective permissions are the key scopes intersected with the owner’s current permissions.
  • 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：sites.read

Parameters

getTenantSiteRollout Parameters
NameInTypeRequiredDescription
rollout_idpathstring(uuid)Yes—

Responses

getTenantSiteRollout Responses
StatusDescription
200Tenant rollout detail.

Fields：id: string(uuid) config_version_id: string(uuid) action: string: apply / rollback state: string: queued / running / paused / succeeded / partial_failed / failed / cancelled revision: integer(int64) max_attempts: integer progress: RolloutProgress can_cancel: boolean can_retry: boolean can_start?: boolean can_pause?: boolean can_resume?: boolean rollout?: RolloutPolicyView pause_reason?: string: / operator / failure_threshold created_at: string(date-time) updated_at: string(date-time)

400Invalid UUID, RFC3339 value, enum, cursor, header, query, or JSON body.
401Authentication is missing or invalid.
403Wrong audience, missing permission, or tenant scope override.
404Resource is absent in the authorized tenant scope. Cross-tenant IDs use the same response.
503Storage, signing, cancellation, response validation, or another internal dependency is unavailable.

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.
  • 404 The resource does not exist or belongs to another tenant.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list

GET /v1/site-rollouts/{rollout_id}/deployments

List deployment progress without node target metadata

operationId
listTenantSiteRolloutDeployments
Auth
  • API key: header Authorization: CdncaKey <key_id>.<secret>. Effective permissions are the key scopes intersected with the owner’s current permissions.
  • 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：sites.read

Parameters

listTenantSiteRolloutDeployments Parameters
NameInTypeRequiredDescription
rollout_idpathstring(uuid)Yes—
limitqueryintegerNo—
cursorquerystringNoVersioned base64url HMAC-SHA256 envelope returned by the immediately preceding page. It is bound to audience, resolved tenant scope, resource kind, and the rollout ID for deployment pages. It cannot be reused across those boundaries or modified.

Responses

listTenantSiteRolloutDeployments Responses
StatusDescription
200Latest deployment attempts with node target IDs omitted.

Fields：items: array<TenantDeployment> next_cursor?: string

400Invalid UUID, RFC3339 value, enum, cursor, header, query, or JSON body.
401Authentication is missing or invalid.
403Wrong audience, missing permission, or tenant scope override.
404Resource is absent in the authorized tenant scope. Cross-tenant IDs use the same response.
503Storage, signing, cancellation, response validation, or another internal dependency is unavailable.

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.
  • 404 The resource does not exist or belongs to another tenant.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list