hosting
POST /v1/uptime/monitors
Start watching a web address.
Authentication
Send an API key as a bearer token. The key must carry the uptime.manage permission; 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/monitors \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "url": <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
Gated on uptime.manage. The address may be any public http(s) URL — we do not need to host it, and it need not belong to the customer at all. Refused with 422 when the address is not a public web address (an internal or non-HTTP address is refused in wording that does not confirm our network shape), when this organisation already watches it, or when its allowance is used up. Every account includes three monitored URLs; further capacity is the uptime_urls_10 extra.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | Which organisation in the caller's subtree the monitor belongs to — what the dashboard's org switcher sends. ⛔ Narrow only: intersected with what the caller may already write… |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
url | string | Yes | Any public http(s) address. Stored canonicalised — userinfo stripped, fragment dropped, default port removed — so what is measured, cached and shown are the same string. |
name | string | No | What to call it on screen. Blank falls back to the host. ⛔ name, not label: label is an attribute of DRF's Field and cannot be a serializer field name, and a read key that… |
expect_text | string | No | Text that must appear in the response for the check to pass. ⭐ This is what catches the failure a status code cannot — a site whose database has gone but whose index still answers… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
url | string | Yes | — |
name | string | No | — |
state | string<unknown, up, down, paused> | Yes | ⛔ unknown is a real state and is not a synonym for up — it means "not checked yet" and is excluded from every uptime percentage. |
enabled | boolean | Yes | — |
expect_text | string | No | — |
site_id | string | No | Set only when the address happens to be one of this organisation's own sites. Navigation only — the monitor works identically without it, and must, because the product exists to… |
last_result_at | string | No | — |
last_up_at | string | No | — |
last_down_at | string | No | — |
created_at | string | Yes | — |
summary | UptimeSummary | No | — |
history | UptimeHistoryPoint[] | No | — |
incidents | UptimeIncident[] | No | — |
vitals | UptimeVitalsPoint[] | No | — |
migration_offer | UptimeMigrationOffer | No | — |
Errors this endpoint can return
401 · 403 · 422