Verify the custom domain

Looks up the page's custom domain in DNS. One passing record verifies it: a CNAME to the page's cname_target, or the TXT record from custom_domain_verification. A verified domain stays verified when a later check fails. routed tells whether visitors reach the page; its certificate is issued on the first visit. The page needs a custom domain (422 otherwise). Safe to repeat while DNS changes propagate.

post/status-pages/{statusPage}/custom-domain/verify

Request

Base URL
https://api.spectate.net/v1
Auth
HTTP bearer

Path parameters

statusPagestring uuid required

Status page ID.

Response

What DNS returned, and whether the domain is verified.

domainstring required

The domain

verifiedboolean required

Whether ownership is proven, now or earlier. A proven domain stays verified when a later check fails

verified_atstring date-time nullable required

When ownership was proven; null before

routedboolean required

Whether visitors reach the page: the domain points at it by CNAME or resolves to the same addresses. The page and its certificate need this; the certificate is issued on the first visit

addressesstring[] required

Addresses the domain resolves to (A and AAAA records)

checked_atstring date-time required

When DNS was checked

Example response

{
  "domain": "status.example.com",
  "records": [
    {
      "name": "_spectate.status.example.com",
      "expected": "spectate-verify=4f1c0c2e9b7a4d3f8e6a5b2c1d0e9f8a"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.