hosting

POST /v1/uptime/status-pages/{page_id}/hostname/verify

Prove the claimed own address, then register it at the edge.

All hosting endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The endpoint checks sites.view, uptime.manage; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/uptime/status-pages/{page_id}/hostname/verify \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Reads the claim's TXT record (_domain-verify.<address>) from a public resolver and, when it carries the claim's token, registers the address at the edge (201, with the CNAME to publish in hostname_records). The record missing ⇒ 422 naming it; the resolver not answering ⇒ 503 and nothing changes; an account not in good standing ⇒ 403. An address any status page or agency panel already holds ⇒ 409, refused before the edge is asked and without saying whose. If the hourly sweep attached it a moment earlier, 200 with the attached address — it is never registered twice.

Parameters

NameTypeRequiredWhat it is
page_id (path)stringYes—

Response

NameTypeRequiredWhat it is
idstringYes—
org_idstringYes—
slugstringYes—
titlestringYes—
introstringNo—
monitor_idsstring[]Yes—
coloursStatusPageColoursYesHex colours (#rrggbb). Text and background pairs need 4.5:1 contrast; brand needs 3:1 on the background.
themestring<auto, light, dark>Yes—
timezonestringYes—
default_localestringYes—
show_response_timesbooleanNo—
publishedbooleanYes—
logostringNoThe stored logo's path (empty when none).
faviconstringNoThe stored favicon's path (empty when none).
hostnamestringYesThe own address
hostname_statusstring<, pending, active, failed>Yes—
hostname_recordsobject[]No—
hostname_claimBrandHostnameClaim | nullNoAn own address asked for and not yet proven (STATUSHOST), with the TXT record that proves it; null when there is none.
fallback_urlstringYes—
public_urlstringYesThe own address once active
updated_atstringNo—

Errors this endpoint can return

401 · 403 · 404 · 409 · 422 · 503