hosting
POST /v1/uptime/status-pages/{page_id}/hostname
Serve the page at the customer's own address (e.g. status.theirsite.com).
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 \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "hostname": <string> }'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
Registers the address at our edge and returns the DNS records to publish (a CNAME, and the ownership and certificate records the edge asks for); the page is served there over TLS once the edge reports it active. ⛔ An own address is a monthly edge charge, so it needs an account in good standing (403 for a suspended one); the page stays at its fallback address either way. An account has at most three pages (409 beyond).
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
page_id (path) | string | Yes | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
hostname | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
org_id | string | Yes | — |
slug | string | Yes | — |
title | string | Yes | — |
intro | string | No | — |
monitor_ids | string[] | Yes | — |
colours | StatusPageColours | Yes | Hex colours (#rrggbb). Text and background pairs need 4.5:1 contrast; brand needs 3:1 on the background. |
theme | string<auto, light, dark> | Yes | — |
timezone | string | Yes | — |
default_locale | string | Yes | — |
show_response_times | boolean | No | — |
published | boolean | Yes | — |
logo | string | No | The stored logo's path (empty when none). |
favicon | string | No | The stored favicon's path (empty when none). |
hostname | string | Yes | The own address |
hostname_status | string<, pending, active, failed> | Yes | — |
hostname_records | object[] | No | — |
fallback_url | string | Yes | — |
public_url | string | Yes | The own address once active |
updated_at | string | No | — |
Errors this endpoint can return
401 · 403 · 404 · 409 · 422 · 503