cdnca

API reference

/v1/certificate-publications

2 operations

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

MethodPathSummaryAuth
GET/v1/certificate-publicationsList current certificate publication statusesSession
GET/v1/certificate-publications/{site_id}/revisions/{revision}Get one binding revision and its complete state historySession

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

Operation details

GET /v1/certificate-publications

List current certificate publication statuses

operationId
listCertificatePublicationStatuses
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：certificates.read

Parameters

listCertificatePublicationStatuses Parameters
NameInTypeRequiredDescription
target_scope_idquerystring(uuid)NoRequired for platform actors; tenant actors may target only their own scope.
statequerystring: pending / leased / retry_wait / succeeded / permanent_failedNo—
operationquerystring: publish / unpublishNo—
site_idquerystring(uuid)No—
limitqueryintegerNo—
cursorquerystringNoOpaque signed snapshot cursor bound to actor, tenant and filters.
X-Request-IDheaderstringNo—

Responses

listCertificatePublicationStatuses Responses
StatusDescription
200Current publication state page from one stable snapshot.

Fields：items: array<PublicationStatus> snapshot_at: string(date-time) next_cursor?: string

400Invalid query, scope target, body or cursor.
401Bearer session missing, malformed or invalid.
403Scope or certificates.read permission denied.
405Only GET is supported.
500Sanitized publication status storage or cursor encoding failure.

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.
  • 500 Outcome unknown: read back by ID or list first, then decide whether to retry with the original Idempotency-Key.

↑ Back to list

GET /v1/certificate-publications/{site_id}/revisions/{revision}

Get one binding revision and its complete state history

operationId
getCertificatePublicationStatus
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：certificates.read

Parameters

getCertificatePublicationStatus Parameters
NameInTypeRequiredDescription
site_idpathstring(uuid)Yes—
revisionpathinteger(int64)Yes—
target_scope_idquerystring(uuid)NoRequired for platform actors; tenant actors may target only their own scope.
X-Request-IDheaderstringNo—

Responses

getCertificatePublicationStatus Responses
StatusDescription
200Current state and complete ordered history for one binding revision.

Fields：current: PublicationStatus history: array<PublicationStatusEvent>

400Invalid query, scope target, body or cursor.
401Bearer session missing, malformed or invalid.
403Scope or certificates.read permission denied.
404Route or exact site binding revision is absent.
405Only GET is supported.
500Sanitized publication status storage or cursor encoding failure.

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.
  • 500 Outcome unknown: read back by ID or list first, then decide whether to retry with the original Idempotency-Key.

↑ Back to list