Status Page

Verify ownership of a status page's custom domain and issue its certificate

Changed on
post/status-pages/{status_page_id}/domains/{domain_id}/verify

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/{domain_id}/verify
  • Auth: HTTP bearer

Path parameters

status_page_idinteger required

Status page ID

domain_idinteger required

Custom domain ID

Response

Verification result; status is active once the certificate is issued

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

  • dd1e6c6ff4f3Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 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