Status Page

Attach a custom domain to a status page

Changed on

The hostname is checked against every hostname this instance already serves. It is served only after ownership is verified through ACME.

post/status-pages/{status_page_id}/domains

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/status-pages/{status_page_id}/domains
  • Auth: HTTP bearer

Path parameters

status_page_idinteger required

Status page ID

Request body

hostnamestring required

Hostname to serve the page on, e.g. status.example.com. Unicode names are converted to punycode; wildcards and IP addresses are refused.

verification_method'http-01' | 'dns-01'

How ownership of a hostname is proven.

Response

Domain attached; create the DNS records, then verify

certificate_expires_atstring date-time nullable
created_atstring date-time required
hostnamestring required
idinteger required
last_errorstring nullable

Reason the last verification failed, if it did.

servingboolean required

True when visitors can open the page on this hostname right now: the hostname is verified and the page is published.

status'pending' | 'active' | 'failed' | 'unverified' | 'renewal_pending' | 'renewal_failed' required

Lifecycle of a custom hostname.

verification_method'http-01' | 'dns-01' required

How ownership of a hostname is proven.

Changes

  • 0fda1aa1af69Revision changes
    • warning

      added the new renewal_failed enum value to the response property for the response status

    • warning

      added the new renewal_pending enum value to the response property for the response status

  • a76c9be89da5Revision changes
    • info

      endpoint added