hosting

PATCH `/v1/uptime/monitors/{monitor_id}`

Pause, resume or rename a monitored address.

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

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 PATCH https://api.zinndigital.com/v1/uptime/monitors/{monitor_id} \
  -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

Gated on `uptime.manage`. ⛔ The **URL cannot be changed**: a monitor's Core Web Vitals readings are joined back to it by that canonical string, so a mutable URL would silently re-point a monitor at another address's history. Change an address by deleting the monitor and adding another. Pausing closes any open incident, so a paused monitor cannot accrue an outage out of us not looking.

Parameters

Name	Type	Required	What it is
`monitor_id (path)`	`string`	Yes	—

Request body

Name	Type	Required	What it is
`enabled`	`boolean`	No	Pause or resume. Pausing closes any open incident.
`name`	`string`	No	—

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 · 404

PATCH /v1/uptime/monitors/{monitor_id}