CDNCA

API reference

/v1/status-page

1 operations

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

MethodPathSummaryAuth
GET/v1/status-page/publicRead the public status pagePublic

Contract file：api/control-status-page.openapi.yaml

Operation details

GET /v1/status-page/public

Read the public status page

operationId
getPublicStatusPage
Auth
  • No authentication.
Required permissions

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

Responses

getPublicStatusPage Responses
StatusDescription
200Public view

Fields：schema: string title: string description?: string show_logo: boolean status: string: operational / degraded / outage / maintenance components: array<PublicComponent> active: array<Incident> upcoming: array<Incident> recent: array<Incident> generated_at: string(date-time)

304Not modified (conditional request)
405Only GET and HEAD are served
404The status page is disabled
429Rate limited by source address
503Status storage is unavailable

What to do on failure

  • 404 The resource does not exist or belongs to another tenant.
  • 429 Rate limited: wait, then retry with lower concurrency.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list