hosting

GET `/v1/uptime/monitors`

The web addresses this organisation has asked us to watch.

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Abfrageparameter. Lassen Sie ihn weg, erfasst der Aufruf Ihren gesamten Mandanten-Unterbaum; übergeben Sie ihn, um den Aufruf auf eine Organisation einzugrenzen.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X GET https://api.zinndigital.com/v1/uptime/monitors \
  -H "Authorization: Bearer zdk_live_…"

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

Every monitored URL in scope with its current state and its 30-day headline numbers, plus the organisation's allowance. ⛔ `summary.uptime_percent` is **null** until there is anything to divide, and `summary.checks` travels beside it so a client can render "not enough data yet" rather than a confident 100% — a monitor added a minute ago has proved nothing. Gated on `sites.view`.

Parameter

Name	Typ	Erforderlich	Was es ist
`org_id (query)`	`string`	Nein	Narrow to one organisation in the caller's subtree — what the dashboard's org switcher sends. ⛔ Narrow only: intersected with what the caller may already read, so an org out…

Antwort

Name	Typ	Erforderlich	Was es ist
`data`	`UptimeMonitor[]`	Ja	—
`allowance`	`UptimeAllowance`	Ja	—

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403