hosting
POST /v1/uptime/status-pages
Create a public status page for the organisation's uptime monitors.
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.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
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 \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'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
slug is optional (one is made from the title). Colours are refused, not adjusted, when text would be hard to read (contrast under 4.5:1, brand under 3:1 on the background). Needs uptime.manage.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
slug | string | No | — |
title | string | No | — |
intro | string | No | — |
monitor_ids | string[] | No | — |
colours | StatusPageColours | No | Hex colours (#rrggbb). Text and background pairs need 4.5:1 contrast; brand needs 3:1 on the background. |
theme | string<auto, light, dark> | No | — |
timezone | string | No | An IANA name such as Europe/London. |
default_locale | string | No | One of the 58 public locales. |
show_response_times | boolean | No | — |
published | boolean | No | — |
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