API reference

Heedery API

Everything the dashboard does, over HTTPS: list and change monitors, follow incidents, plan maintenance and mark deploys. Plain REST with predictable URLs, JSON bodies and the usual status codes.

Auth
Authorization: Bearer hda_…
Format
JSON in and out, UTF-8. Times are ISO 8601 in UTC.
Spec
OpenAPI · v1.0.0 · openapi.json

Your first request

Thirty seconds, three steps.

  1. 01
    Make a token
    In the dashboard open Settings → Integrations and create one in the API section. Pro and up can make read tokens; Team and up can also make write tokens. It is shown once and starts with hda_.
  2. 02
    Keep it in the environment
    export HEEDERY_TOKEN=hda_…Every sample on this page reads it from there.
  3. 03
    Ask for something
    Run the sample in your language. It answers with the state of every monitor in the workspace.
GET/status
Response 200
{
  "workspace": {
    "id": "cmh3k2x9a0000qv08wksp0001",
    "name": "Acme"
  },
  "generatedAt": "2026-11-10T09:30:00.000Z",
  "sites": [
    {
      "id": "cmh3k2x9a0001qv08abcd1234",
      "name": "Shop",
      "url": "https://shop.example.com/",
      "kind": "web",
      "enabled": true,
      "state": "up",
      "checkedAt": "2026-11-10T09:29:12.000Z",
      "latencyMs": 182,
      "statusCode": 200,
      "error": null,
      "incident": null
    }
  ]
}

Use it from Claude, Cursor or VS Code

Heedery runs an MCP server at https://heedery.com/api/mcp, so an assistant can answer “what went down last night?” from your real data, and with a write token pause a monitor or acknowledge an incident when you ask it to.

claude.ai needs no token: in Settings → Connectors → Add custom connector, paste https://heedery.com/api/mcp, press Connect, sign in to Heedery, pick the workspace and read or write, and allow it. Claude Desktop and mobile share the connector. Claude Code, Cursor and VS Code sign in the same way: add the server by its URL alone and they open Heedery to ask you. Cursor gets the code back through its own cursor:// link.

Clients that do not sign in take the same tokens and scopes as the API, in the Authorization header. Give it a read token if all you want is answers.

For client authors: a 401 points at https://heedery.com/.well-known/oauth-protected-resource/api/mcp; then a Client ID Metadata Document (an https client_id, fetched with no redirects, 5 seconds and 5 KB at most) or dynamic registration, the authorization code flow with PKCE (S256) and the resource parameter. Redirect URIs are https, http on localhost on any port, or an app’s own scheme such as com.example.app:/callback. Access tokens last an hour and refresh tokens rotate on every use.

claude.ai · custom connector
# Settings → Connectors → Add custom connector
# Name: Heedery
# URL:  https://heedery.com/api/mcp
# then Connect, sign in, Allow
Claude Code
# Sign in: add it, then /mcp → Authenticate
claude mcp add --transport http heedery https://heedery.com/api/mcp

# Or with a token
claude mcp add --transport http heedery https://heedery.com/api/mcp \
  --header "Authorization: Bearer $HEEDERY_TOKEN"
Cursor · .cursor/mcp.json, then Connect
{
  "mcpServers": {
    "heedery": {
      "url": "https://heedery.com/api/mcp"
    }
  }
}
VS Code · .vscode/mcp.json
{
  "servers": {
    "heedery": {
      "type": "http",
      "url": "https://heedery.com/api/mcp"
    }
  }
}

Authentication

Send the token in the Authorization header as Bearer hda_…. A request without one, or with one that was rotated or deleted, gets 401.

A token belongs to one workspace and sees all of it. Keep it out of code and browsers: anyone holding it can do what its scope allows. Rotating it in the API section of Settings → Integrations stops the old one at once.

Scopes

read
Every GET: monitors, incidents, maintenance, deploys, status.Pro and up
write
Also creates, changes and deletes: pause, acknowledge, schedule, mark deploys.Team and up
public
1 endpoints.Starter and up

A read token calling a write endpoint gets 403, as does any token once the plan no longer includes the API.

Authenticated request
curl https://heedery.com/api/v1/monitors \
  -H "Authorization: Bearer $HEEDERY_TOKEN"

Errors

A 2xx status means it worked. Anything else comes with the same body: an error object whose code is stable enough to branch on and whose message is written for people.

5xx answers are ours and safe to retry; use an idempotency key on POSTs so a retry never does the work twice.

The error object

  • codestringrequired
    Stable, machine-readable reason. Branch on this, not on the message.
  • messagestringrequired
    What went wrong, in a sentence for people.
  • detailsany
    Extra facts where they help: the fields that failed validation, the scope or plan needed.

Codes

invalid_request
validation_failed
unauthorized
forbidden
scope_required
plan_required
needs_plan
monitor_limit_reached
browser_limit_reached
interval_below_plan
not_found
incident_resolved
not_running
not_upcoming
window_closed
idempotency_key_reused
idempotency_in_progress
rate_limited
internal_error

Pagination

Lists come a page at a time as { data, nextCursor }. Pass nextCursor back as cursor for the next page; it is null on the last one.

Cursors keep their place when items are added while you read, so nothing is skipped or seen twice. Treat them as opaque: they may change shape.

Parameters on every list

  • cursorstring
    The nextCursor of the previous page; leave out for the first page. Opaque: do not build or parse it.
  • limitinteger
    How many items to return, 1 to 100.

    Default 501 to 100

Every page, in JavaScript
let cursor = null;
do {
  const url = new URL('https://heedery.com/api/v1/monitors');
  url.searchParams.set('limit', '100');
  if (cursor) url.searchParams.set('cursor', cursor);
  const res = await fetch(url, {
    headers: { Authorization: `Bearer ${process.env.HEEDERY_TOKEN}` },
  });
  const page = await res.json();
  for (const item of page.data) console.log(item.id);
  cursor = page.nextCursor;
} while (cursor);

Idempotency

Networks drop answers. To retry a POST without doing it twice, send an Idempotency-Key header with a value of your own, a UUID say. A second request with the same key gets the first one’s answer back instead of running again.

Reusing a key with a different body is a 422; a retry while the first request still runs is a 409. GET, PATCH and DELETE are safe to repeat as they are.

Header

  • Idempotency-Keystring
    Any unique string (a UUID). A retry with the same key and body within 24 hours gets the first answer instead of doing it twice.

    up to 255 characters

POST/deploys
curl -X POST https://heedery.com/api/v1/deploys \
  -H "Authorization: Bearer $HEEDERY_TOKEN" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: <Idempotency-Key>' \
  -d '{
  "version": "v1.4.2",
  "commit": "9f2c1ab",
  "environment": "production",
  "monitors": [
    "shop.example.com"
  ]
}'

Rate limits

Each token has a budget of requests per minute, reads and writes counted apart, set by the workspace’s plan. Every answer says how much of it is left; past it the API answers 429 with a Retry-After until the minute is over. MCP tool calls count against the same budget.

Polling for status? One status call covers every monitor, so a dashboard needs a single request per refresh.

Per token, by plan

PlanReads a minuteWrites a minute
Pro120— read-only
Team30060
Agency, Enterprise600120

Headers

RateLimit-Limit
Requests of this kind (reads or writes) this token may make per minute, set by the workspace’s plan.
RateLimit-Remaining
Requests left in the current minute.
RateLimit-Reset
Seconds until the window resets.
Retry-After
Seconds to wait before trying again.
Response headers
HTTP/1.1 429 Too Many Requests
RateLimit-Limit: 300
RateLimit-Remaining: 0
RateLimit-Reset: 42
Retry-After: 42

The monitor object

A monitor: a site, API, server or heartbeat Heedery checks.

Attributes

  • idstringrequired
    The monitor.
  • namestringrequired
  • descriptionstring · nullablerequired
  • typestringrequired
    How the monitor checks: http (a web page or API), tcp (a port), dns (a record), ping, udp, mail (SMTP, IMAP or POP3), browser (a browser flow: scripted steps in a real browser) or heartbeat (your job pings us; we alert when the pings stop).

    One ofhttptcpdnspingudpmailbrowserheartbeat

  • kindstringrequired
    What it is: a website, an API or a heartbeat. Picks the icon and the defaults (an API counts a response slower than 2 s as down).

    One ofwebapiheartbeat

  • urlstringrequired
    The target: https://… for http, tcp://host:port, dns://hostname, ping://host, udp://host:port, smtp|imap|pop3://host:port for mail, heartbeat://name for a heartbeat.
  • enabledbooleanrequired
    False while paused.
  • pausedByPlanbooleanrequired
    Paused because a plan change left more monitors than the plan allows.
  • statestringrequired
    The state the Overview shows: up; down (an open incident or a failed last check); paused; unknown (no check yet, or the checker stopped reporting); maintenance (inside a maintenance window: alerts are held); blocked (a bot wall answered instead of the site, so it is up but we cannot see it).

    One ofupdownpausedunknownmaintenanceblocked

  • checkedAtstring (ISO 8601) · nullablerequired
    When the last check ran.
  • latencyMsinteger · nullablerequired
    Response time of the last check.
  • statusCodeinteger · nullablerequired
    HTTP status of the last check.
  • errorstring · nullablerequired
    Why the last check failed.
  • incidentobject · nullablerequired
    The open incident, if the monitor is down.
    Show 3 child fields
    • idstringrequired
      The open incident.
    • startedAtstring (ISO 8601)required
      The first failed check.
    • errorstring · nullablerequired
  • checkIntervalintegerrequired
    Minutes between checks; for a heartbeat, the period between pings.
  • alertAfterMinutesintegerrequired
    Minutes it may stay down before an incident opens and anyone is told; 0 = at once.
  • categoryIdstring · nullablerequired
  • categoryobject · nullablerequired
    The category it is filed under (agencies often use one per client).
    Show 2 child fields
    • idstringrequired
    • namestringrequired
  • statusPageIdstring · nullablerequired
  • escalationPolicyIdstring · nullablerequired
    Who is paged and when; null = the workspace default.
  • pinnedbooleanrequired
  • httpMethodstringrequired

    One ofGETHEADPOSTPUTPATCHDELETE

  • requestHeadersarray of objects · nullablerequired
    Headers the check sends. A read-only token sees the names with the values hidden.
    Show 2 child fields
    • namestringrequired

      up to 100 characters

    • valuestringrequired

      up to 2000 characters

  • requestBodystring · nullablerequired
  • keywordstring · nullablerequired
  • keywordModestringrequired

    One ofcontainsabsent

  • jsonPathstring · nullablerequired
  • jsonExpectedstring · nullablerequired
  • expectedStatusCodesstring · nullablerequired
    Codes that count as up, like 200-299,404; null = 200-399.
  • maxLatencyMsinteger · nullablerequired
    A slower response counts as down; null = only the timeout.
  • dnsRecordTypestringrequired

    One ofAAAAACNAMEMXTXT

  • dnsExpectedstring · nullablerequired
  • pingMaxLossinteger · nullablerequired
  • udpPayloadstring · nullablerequired
  • udpPayloadFormatstringrequired

    One oftexthex

  • udpExpectedstring · nullablerequired
  • mailTlsstringrequired

    One ofnonestarttlstls

  • heartbeatGraceintegerrequired
    Heartbeat: minutes of grace on top of the period.
  • heartbeatUrlstring · nullablerequired
    Heartbeat: the URL your job calls. Only tokens with the write scope see it (it is a secret: anyone with it can ping).
  • checkSslbooleanrequired
  • checkDomainExpirybooleanrequired
  • sslobject · nullablerequired
    Show 2 child fields
    • validboolean · nullablerequired
    • expiresAtstring (ISO 8601) · nullablerequired
      When the certificate expires.
  • domainExpiresAtstring (ISO 8601) · nullablerequired
    When the domain registration ends.
  • emailAlertsbooleanrequired
  • alertEmailsstring · nullablerequired
    Extra alert recipients, comma separated.
  • expiryAlertsbooleanrequired
  • createdAtstring (ISO 8601)required
    When it was added.
  • updatedAtstring (ISO 8601)required
    When it last changed.
  • linksobjectrequired
    Show 1 child field
    • monitorstringrequired
      The monitor in the Heedery app (needs a sign-in).
The monitor object
{
  "id": "cmh3k2x9a0001qv08abcd1234",
  "name": "Shop checkout",
  "description": null,
  "type": "http",
  "kind": "web",
  "url": "https://shop.example.com/checkout",
  "enabled": true,
  "pausedByPlan": false,
  "state": "up",
  "checkedAt": "2026-11-10T09:29:12.000Z",
  "latencyMs": 182,
  "statusCode": 200,
  "error": null,
  "incident": null,
  "checkInterval": 1,
  "alertAfterMinutes": 0,
  "categoryId": "cmh3k2x9a0002qv08cat00001",
  "category": {
    "id": "cmh3k2x9a0002qv08cat00001",
    "name": "Acme Ltd"
  },
  "statusPageId": "cmh3k2x9a0003qv08page0001",
  "escalationPolicyId": null,
  "pinned": false,
  "httpMethod": "GET",
  "requestHeaders": null,
  "requestBody": null,
  "keyword": "Pay now",
  "keywordMode": "contains",
  "jsonPath": null,
  "jsonExpected": null,
  "expectedStatusCodes": null,
  "maxLatencyMs": null,
  "dnsRecordType": "A",
  "dnsExpected": null,
  "pingMaxLoss": null,
  "udpPayload": null,
  "udpPayloadFormat": "text",
  "udpExpected": null,
  "mailTls": "starttls",
  "heartbeatGrace": 5,
  "heartbeatUrl": null,
  "checkSsl": true,
  "checkDomainExpiry": false,
  "ssl": {
    "valid": true,
    "expiresAt": "2027-01-20T23:59:59.000Z"
  },
  "domainExpiresAt": null,
  "emailAlerts": true,
  "alertEmails": null,
  "expiryAlerts": true,
  "createdAt": "2026-10-01T08:00:00.000Z",
  "updatedAt": "2026-11-09T14:12:00.000Z",
  "links": {
    "monitor": "https://heedery.com/admin/sites/cmh3k2x9a0001qv08abcd1234"
  }
}

List monitors

GET/monitors

scopereadplanPro and up

Every monitor of the workspace, oldest first, with its current state and last check. Filter by state, type, category or a search term; page with cursor.

Needs: any token (read scope), on the Pro plan or above.

Query parameters

  • statusstring

    One ofupdownpausedunknownmaintenanceblocked

  • typestring

    One ofhttptcpdnspingudpmailbrowserheartbeat

  • categorystring

    up to 100 characters

  • qstring

    up to 200 characters

  • limitinteger
    How many items to return, 1 to 100.

    Default 501 to 100

  • cursorstring
    The nextCursor of the previous page; leave out for the first page. Opaque: do not build or parse it.

Returns

200A page of monitors.

Show the response fields
  • dataarray of objectsrequired
    Show 49 child fields
    • idstringrequired
      The monitor.
    • namestringrequired
    • descriptionstring · nullablerequired
    • typestringrequired
      How the monitor checks: http (a web page or API), tcp (a port), dns (a record), ping, udp, mail (SMTP, IMAP or POP3), browser (a browser flow: scripted steps in a real browser) or heartbeat (your job pings us; we alert when the pings stop).

      One ofhttptcpdnspingudpmailbrowserheartbeat

    • kindstringrequired
      What it is: a website, an API or a heartbeat. Picks the icon and the defaults (an API counts a response slower than 2 s as down).

      One ofwebapiheartbeat

    • urlstringrequired
      The target: https://… for http, tcp://host:port, dns://hostname, ping://host, udp://host:port, smtp|imap|pop3://host:port for mail, heartbeat://name for a heartbeat.
    • enabledbooleanrequired
      False while paused.
    • pausedByPlanbooleanrequired
      Paused because a plan change left more monitors than the plan allows.
    • statestringrequired
      The state the Overview shows: up; down (an open incident or a failed last check); paused; unknown (no check yet, or the checker stopped reporting); maintenance (inside a maintenance window: alerts are held); blocked (a bot wall answered instead of the site, so it is up but we cannot see it).

      One ofupdownpausedunknownmaintenanceblocked

    • checkedAtstring (ISO 8601) · nullablerequired
      When the last check ran.
    • latencyMsinteger · nullablerequired
      Response time of the last check.
    • statusCodeinteger · nullablerequired
      HTTP status of the last check.
    • errorstring · nullablerequired
      Why the last check failed.
    • incidentobject · nullablerequired
      The open incident, if the monitor is down.
      Show 3 child fields
      • idstringrequired
        The open incident.
      • startedAtstring (ISO 8601)required
        The first failed check.
      • errorstring · nullablerequired
    • checkIntervalintegerrequired
      Minutes between checks; for a heartbeat, the period between pings.
    • alertAfterMinutesintegerrequired
      Minutes it may stay down before an incident opens and anyone is told; 0 = at once.
    • categoryIdstring · nullablerequired
    • categoryobject · nullablerequired
      The category it is filed under (agencies often use one per client).
      Show 2 child fields
      • idstringrequired
      • namestringrequired
    • statusPageIdstring · nullablerequired
    • escalationPolicyIdstring · nullablerequired
      Who is paged and when; null = the workspace default.
    • pinnedbooleanrequired
    • httpMethodstringrequired

      One ofGETHEADPOSTPUTPATCHDELETE

    • requestHeadersarray of objects · nullablerequired
      Headers the check sends. A read-only token sees the names with the values hidden.
      Show 2 child fields
      • namestringrequired

        up to 100 characters

      • valuestringrequired

        up to 2000 characters

    • requestBodystring · nullablerequired
    • keywordstring · nullablerequired
    • keywordModestringrequired

      One ofcontainsabsent

    • jsonPathstring · nullablerequired
    • jsonExpectedstring · nullablerequired
    • expectedStatusCodesstring · nullablerequired
      Codes that count as up, like 200-299,404; null = 200-399.
    • maxLatencyMsinteger · nullablerequired
      A slower response counts as down; null = only the timeout.
    • dnsRecordTypestringrequired

      One ofAAAAACNAMEMXTXT

    • dnsExpectedstring · nullablerequired
    • pingMaxLossinteger · nullablerequired
    • udpPayloadstring · nullablerequired
    • udpPayloadFormatstringrequired

      One oftexthex

    • udpExpectedstring · nullablerequired
    • mailTlsstringrequired

      One ofnonestarttlstls

    • heartbeatGraceintegerrequired
      Heartbeat: minutes of grace on top of the period.
    • heartbeatUrlstring · nullablerequired
      Heartbeat: the URL your job calls. Only tokens with the write scope see it (it is a secret: anyone with it can ping).
    • checkSslbooleanrequired
    • checkDomainExpirybooleanrequired
    • sslobject · nullablerequired
      Show 2 child fields
      • validboolean · nullablerequired
      • expiresAtstring (ISO 8601) · nullablerequired
        When the certificate expires.
    • domainExpiresAtstring (ISO 8601) · nullablerequired
      When the domain registration ends.
    • emailAlertsbooleanrequired
    • alertEmailsstring · nullablerequired
      Extra alert recipients, comma separated.
    • expiryAlertsbooleanrequired
    • createdAtstring (ISO 8601)required
      When it was added.
    • updatedAtstring (ISO 8601)required
      When it last changed.
    • linksobjectrequired
      Show 1 child field
      • monitorstringrequired
        The monitor in the Heedery app (needs a sign-in).
  • nextCursorstring · nullablerequired
    Pass as cursor to get the next page; null on the last page.
400
Bad request: invalid_request (A query parameter, the cursor or the JSON is malformed.)
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
GET/monitors
Response 200
{
  "data": [
    {
      "id": "cmh3k2x9a0001qv08abcd1234",
      "name": "Shop checkout",
      "description": null,
      "type": "http",
      "kind": "web",
      "url": "https://shop.example.com/checkout",
      "enabled": true,
      "pausedByPlan": false,
      "state": "up",
      "checkedAt": "2026-11-10T09:29:12.000Z",
      "latencyMs": 182,
      "statusCode": 200,
      "error": null,
      "incident": null,
      "checkInterval": 1,
      "alertAfterMinutes": 0,
      "categoryId": "cmh3k2x9a0002qv08cat00001",
      "category": {
        "id": "cmh3k2x9a0002qv08cat00001",
        "name": "Acme Ltd"
      },
      "statusPageId": "cmh3k2x9a0003qv08page0001",
      "escalationPolicyId": null,
      "pinned": false,
      "httpMethod": "GET",
      "requestHeaders": null,
      "requestBody": null,
      "keyword": "Pay now",
      "keywordMode": "contains",
      "jsonPath": null,
      "jsonExpected": null,
      "expectedStatusCodes": null,
      "maxLatencyMs": null,
      "dnsRecordType": "A",
      "dnsExpected": null,
      "pingMaxLoss": null,
      "udpPayload": null,
      "udpPayloadFormat": "text",
      "udpExpected": null,
      "mailTls": "starttls",
      "heartbeatGrace": 5,
      "heartbeatUrl": null,
      "checkSsl": true,
      "checkDomainExpiry": false,
      "ssl": {
        "valid": true,
        "expiresAt": "2027-01-20T23:59:59.000Z"
      },
      "domainExpiresAt": null,
      "emailAlerts": true,
      "alertEmails": null,
      "expiryAlerts": true,
      "createdAt": "2026-10-01T08:00:00.000Z",
      "updatedAt": "2026-11-09T14:12:00.000Z",
      "links": {
        "monitor": "https://heedery.com/admin/sites/cmh3k2x9a0001qv08abcd1234"
      }
    }
  ],
  "nextCursor": null
}

Create a monitor

POST/monitors

scopewriteplanTeam and upIdempotent with a key

Adds a monitor, checked from the next minute. The same rules as the app apply: your plan’s monitor count and shortest interval, browser flows per plan, and no private or internal targets. Send an Idempotency-Key so a retry cannot add it twice.

Needs: a token with the write scope, on the Team plan or above.

Headers

  • Idempotency-Keystring
    Any unique string (a UUID). A retry with the same key and body within 24 hours gets the first answer instead of doing it twice.

    up to 255 characters

Body

JSON
  • namestringrequired

    1 to 200 characters

  • typestring
    How the monitor checks: http (a web page or API), tcp (a port), dns (a record), ping, udp, mail (SMTP, IMAP or POP3), browser (a browser flow: scripted steps in a real browser) or heartbeat (your job pings us; we alert when the pings stop).

    One ofhttptcpdnspingudpmailbrowserheartbeat

    Default http

  • kindstring
    For checks other than heartbeats: web (default) or api. An API counts a response slower than 2 s as down unless you set maxLatencyMs.

    One ofwebapi

  • urlstring
    The target, required except for heartbeats: https://shop.example.com, db.example.com:5432 (tcp), example.com (dns, ping), ntp.example.com:123 (udp), smtp://mail.example.com:587 (mail). Private and internal addresses are refused.

    up to 2000 characters

  • descriptionstring · nullable

    up to 2000 characters

  • enabledboolean
    False to create it paused. On update, prefer /pause and /resume.
  • checkIntervalinteger
    Minutes between checks, 1 to 10080 (15 by default). Your plan sets the floor (Starter 10, others 1); browser flows run at most every 5.

    1 to 10080

  • alertAfterMinutesinteger
    Minutes it may stay down before an incident opens, 0 to 30 (0 by default).

    0 to 30

  • categoryIdstring · nullable
  • statusPageIdstring · nullable
    The status page it shows on. Left out or null, it is on no page: a new monitor is never published by itself.
  • escalationPolicyIdstring · nullable
  • httpMethodstring

    One ofGETHEADPOSTPUTPATCHDELETE

  • requestHeadersarray of objects · nullable

    up to 20 items

    Show 2 child fields
    • namestringrequired

      up to 100 characters

    • valuestringrequired

      up to 2000 characters

  • requestBodystring · nullable

    up to 10000 characters

  • keywordstring · nullable
    Text the response must contain (or must not).

    up to 500 characters

  • keywordModestring

    One ofcontainsabsent

  • jsonPathstring · nullable
    A dot path into a JSON response, like status or checks.db.

    up to 200 characters

  • jsonExpectedstring · nullable

    up to 500 characters

  • expectedStatusCodesstring · nullable

    up to 200 characters

  • maxLatencyMsinteger · nullable

    50 to 60000

  • dnsRecordTypestring

    One ofAAAAACNAMEMXTXT

  • dnsExpectedstring · nullable

    up to 500 characters

  • pingMaxLossinteger · nullable

    0 to 99

  • udpPayloadstring · nullable

    up to 4000 characters

  • udpPayloadFormatstring

    One oftexthex

  • udpExpectedstring · nullable

    up to 500 characters

  • mailTlsstring

    One ofnonestarttlstls

  • heartbeatGraceinteger

    0 to 1440

  • browserStepsarray of objects
    Browser flows: the scenario, the steps as the app’s editor saves them ({ "type": "goto", "url": "https://…" }, click, fill, expect_text…). The first goto URL becomes the monitor’s url.

    up to 20 items

  • checkSslboolean
  • checkDomainExpiryboolean
  • emailAlertsboolean
  • alertEmailsstring · nullable

    up to 2000 characters

Returns

201The new monitor: a monitor object.

400
Bad request: invalid_request (A query parameter, the cursor or the JSON is malformed.)
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.); scope_required (The token only reads; this needs the write scope.); monitor_limit_reached (The plan’s monitors are all in use.); interval_below_plan (The plan does not check that often.); browser_limit_reached (The plan’s browser flows are all in use.); needs_plan (The workspace has no plan, so it runs no monitors.)
409
Conflict: idempotency_in_progress (A request with this Idempotency-Key is still running.)
422
Unprocessable: validation_failed (A field is wrong; details lists them.); idempotency_key_reused (The Idempotency-Key was used with a different request.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
POST/monitors
Response 201
{
  "id": "cmh3k2x9a0001qv08abcd1234",
  "name": "Shop checkout",
  "description": null,
  "type": "http",
  "kind": "web",
  "url": "https://shop.example.com/checkout",
  "enabled": true,
  "pausedByPlan": false,
  "state": "up",
  "checkedAt": "2026-11-10T09:29:12.000Z",
  "latencyMs": 182,
  "statusCode": 200,
  "error": null,
  "incident": null,
  "checkInterval": 1,
  "alertAfterMinutes": 0,
  "categoryId": "cmh3k2x9a0002qv08cat00001",
  "category": {
    "id": "cmh3k2x9a0002qv08cat00001",
    "name": "Acme Ltd"
  },
  "statusPageId": "cmh3k2x9a0003qv08page0001",
  "escalationPolicyId": null,
  "pinned": false,
  "httpMethod": "GET",
  "requestHeaders": null,
  "requestBody": null,
  "keyword": "Pay now",
  "keywordMode": "contains",
  "jsonPath": null,
  "jsonExpected": null,
  "expectedStatusCodes": null,
  "maxLatencyMs": null,
  "dnsRecordType": "A",
  "dnsExpected": null,
  "pingMaxLoss": null,
  "udpPayload": null,
  "udpPayloadFormat": "text",
  "udpExpected": null,
  "mailTls": "starttls",
  "heartbeatGrace": 5,
  "heartbeatUrl": null,
  "checkSsl": true,
  "checkDomainExpiry": false,
  "ssl": {
    "valid": true,
    "expiresAt": "2027-01-20T23:59:59.000Z"
  },
  "domainExpiresAt": null,
  "emailAlerts": true,
  "alertEmails": null,
  "expiryAlerts": true,
  "createdAt": "2026-10-01T08:00:00.000Z",
  "updatedAt": "2026-11-09T14:12:00.000Z",
  "links": {
    "monitor": "https://heedery.com/admin/sites/cmh3k2x9a0001qv08abcd1234"
  }
}

Get a monitor

GET/monitors/{id}

scopereadplanPro and up

One monitor with its settings, state and last check. For uptime and response times over time, see /monitors/{id}/metrics.

Needs: any token (read scope), on the Pro plan or above.

Path parameters

  • idstringrequired
    The record id.

Returns

200The monitor: a monitor object.

401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.)
404
Not found: not_found (No such thing in this workspace.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
GET/monitors/{id}
Response 200
{
  "id": "cmh3k2x9a0001qv08abcd1234",
  "name": "Shop checkout",
  "description": null,
  "type": "http",
  "kind": "web",
  "url": "https://shop.example.com/checkout",
  "enabled": true,
  "pausedByPlan": false,
  "state": "up",
  "checkedAt": "2026-11-10T09:29:12.000Z",
  "latencyMs": 182,
  "statusCode": 200,
  "error": null,
  "incident": null,
  "checkInterval": 1,
  "alertAfterMinutes": 0,
  "categoryId": "cmh3k2x9a0002qv08cat00001",
  "category": {
    "id": "cmh3k2x9a0002qv08cat00001",
    "name": "Acme Ltd"
  },
  "statusPageId": "cmh3k2x9a0003qv08page0001",
  "escalationPolicyId": null,
  "pinned": false,
  "httpMethod": "GET",
  "requestHeaders": null,
  "requestBody": null,
  "keyword": "Pay now",
  "keywordMode": "contains",
  "jsonPath": null,
  "jsonExpected": null,
  "expectedStatusCodes": null,
  "maxLatencyMs": null,
  "dnsRecordType": "A",
  "dnsExpected": null,
  "pingMaxLoss": null,
  "udpPayload": null,
  "udpPayloadFormat": "text",
  "udpExpected": null,
  "mailTls": "starttls",
  "heartbeatGrace": 5,
  "heartbeatUrl": null,
  "checkSsl": true,
  "checkDomainExpiry": false,
  "ssl": {
    "valid": true,
    "expiresAt": "2027-01-20T23:59:59.000Z"
  },
  "domainExpiresAt": null,
  "emailAlerts": true,
  "alertEmails": null,
  "expiryAlerts": true,
  "createdAt": "2026-10-01T08:00:00.000Z",
  "updatedAt": "2026-11-09T14:12:00.000Z",
  "links": {
    "monitor": "https://heedery.com/admin/sites/cmh3k2x9a0001qv08abcd1234"
  }
}

Update a monitor

PATCH/monitors/{id}

scopewriteplanTeam and up

Changes the fields you send and keeps the rest. Changing type or url re-checks the target the way the app does.

Needs: a token with the write scope, on the Team plan or above.

Path parameters

  • idstringrequired
    The record id.

Body

JSON
  • namestring

    1 to 200 characters

  • typestring
    How the monitor checks: http (a web page or API), tcp (a port), dns (a record), ping, udp, mail (SMTP, IMAP or POP3), browser (a browser flow: scripted steps in a real browser) or heartbeat (your job pings us; we alert when the pings stop).

    One ofhttptcpdnspingudpmailbrowserheartbeat

  • kindstring

    One ofwebapi

  • urlstring

    up to 2000 characters

  • pinnedboolean
    Kept near the top of the Overview.
  • expiryAlertsboolean
  • descriptionstring · nullable

    up to 2000 characters

  • enabledboolean
    False to create it paused. On update, prefer /pause and /resume.
  • checkIntervalinteger
    Minutes between checks, 1 to 10080 (15 by default). Your plan sets the floor (Starter 10, others 1); browser flows run at most every 5.

    1 to 10080

  • alertAfterMinutesinteger
    Minutes it may stay down before an incident opens, 0 to 30 (0 by default).

    0 to 30

  • categoryIdstring · nullable
  • statusPageIdstring · nullable
    The status page it shows on. Left out or null, it is on no page: a new monitor is never published by itself.
  • escalationPolicyIdstring · nullable
  • httpMethodstring

    One ofGETHEADPOSTPUTPATCHDELETE

  • requestHeadersarray of objects · nullable

    up to 20 items

    Show 2 child fields
    • namestringrequired

      up to 100 characters

    • valuestringrequired

      up to 2000 characters

  • requestBodystring · nullable

    up to 10000 characters

  • keywordstring · nullable
    Text the response must contain (or must not).

    up to 500 characters

  • keywordModestring

    One ofcontainsabsent

  • jsonPathstring · nullable
    A dot path into a JSON response, like status or checks.db.

    up to 200 characters

  • jsonExpectedstring · nullable

    up to 500 characters

  • expectedStatusCodesstring · nullable

    up to 200 characters

  • maxLatencyMsinteger · nullable

    50 to 60000

  • dnsRecordTypestring

    One ofAAAAACNAMEMXTXT

  • dnsExpectedstring · nullable

    up to 500 characters

  • pingMaxLossinteger · nullable

    0 to 99

  • udpPayloadstring · nullable

    up to 4000 characters

  • udpPayloadFormatstring

    One oftexthex

  • udpExpectedstring · nullable

    up to 500 characters

  • mailTlsstring

    One ofnonestarttlstls

  • heartbeatGraceinteger

    0 to 1440

  • browserStepsarray of objects
    Browser flows: the scenario, the steps as the app’s editor saves them ({ "type": "goto", "url": "https://…" }, click, fill, expect_text…). The first goto URL becomes the monitor’s url.

    up to 20 items

  • checkSslboolean
  • checkDomainExpiryboolean
  • emailAlertsboolean
  • alertEmailsstring · nullable

    up to 2000 characters

Returns

200The monitor as it is now: a monitor object.

400
Bad request: invalid_request (A query parameter, the cursor or the JSON is malformed.)
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.); scope_required (The token only reads; this needs the write scope.); interval_below_plan (The plan does not check that often.); browser_limit_reached (The plan’s browser flows are all in use.); monitor_limit_reached (The plan’s monitors are all in use.)
404
Not found: not_found (No such thing in this workspace.)
422
Unprocessable: validation_failed (A field is wrong; details lists them.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
PATCH/monitors/{id}
Response 200
{
  "id": "cmh3k2x9a0001qv08abcd1234",
  "name": "Shop checkout",
  "description": null,
  "type": "http",
  "kind": "web",
  "url": "https://shop.example.com/checkout",
  "enabled": true,
  "pausedByPlan": false,
  "state": "up",
  "checkedAt": "2026-11-10T09:29:12.000Z",
  "latencyMs": 182,
  "statusCode": 200,
  "error": null,
  "incident": null,
  "checkInterval": 1,
  "alertAfterMinutes": 0,
  "categoryId": "cmh3k2x9a0002qv08cat00001",
  "category": {
    "id": "cmh3k2x9a0002qv08cat00001",
    "name": "Acme Ltd"
  },
  "statusPageId": "cmh3k2x9a0003qv08page0001",
  "escalationPolicyId": null,
  "pinned": false,
  "httpMethod": "GET",
  "requestHeaders": null,
  "requestBody": null,
  "keyword": "Pay now",
  "keywordMode": "contains",
  "jsonPath": null,
  "jsonExpected": null,
  "expectedStatusCodes": null,
  "maxLatencyMs": null,
  "dnsRecordType": "A",
  "dnsExpected": null,
  "pingMaxLoss": null,
  "udpPayload": null,
  "udpPayloadFormat": "text",
  "udpExpected": null,
  "mailTls": "starttls",
  "heartbeatGrace": 5,
  "heartbeatUrl": null,
  "checkSsl": true,
  "checkDomainExpiry": false,
  "ssl": {
    "valid": true,
    "expiresAt": "2027-01-20T23:59:59.000Z"
  },
  "domainExpiresAt": null,
  "emailAlerts": true,
  "alertEmails": null,
  "expiryAlerts": true,
  "createdAt": "2026-10-01T08:00:00.000Z",
  "updatedAt": "2026-11-09T14:12:00.000Z",
  "links": {
    "monitor": "https://heedery.com/admin/sites/cmh3k2x9a0001qv08abcd1234"
  }
}

Delete a monitor

DEL/monitors/{id}

scopewriteplanTeam and up

Deletes the monitor with its incidents and history. This cannot be undone; to stop checks for a while, pause it instead.

Needs: a token with the write scope, on the Team plan or above.

Path parameters

  • idstringrequired
    The record id.

Returns

200It is gone.

Show the response fields
  • idstringrequired
  • deletedbooleanrequired

    Always true

400
Bad request: invalid_request (A query parameter, the cursor or the JSON is malformed.)
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.); scope_required (The token only reads; this needs the write scope.)
404
Not found: not_found (No such thing in this workspace.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
DEL/monitors/{id}
Response 200
{
  "id": "cmh3k2x9a0001qv08abcd1234",
  "deleted": true
}

Pause a monitor

POST/monitors/{id}/pause

scopewriteplanTeam and upIdempotent with a key

Stops checks and alerts until it is resumed. Pausing a paused monitor changes nothing.

Needs: a token with the write scope, on the Team plan or above.

Path parameters

  • idstringrequired
    The record id.

Headers

  • Idempotency-Keystring
    Any unique string (a UUID). A retry with the same key and body within 24 hours gets the first answer instead of doing it twice.

    up to 255 characters

Returns

200The paused monitor: a monitor object.

400
Bad request: invalid_request (A query parameter, the cursor or the JSON is malformed.)
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.); scope_required (The token only reads; this needs the write scope.)
404
Not found: not_found (No such thing in this workspace.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
POST/monitors/{id}/pause
Response 200
{
  "id": "cmh3k2x9a0001qv08abcd1234",
  "name": "Shop checkout",
  "description": null,
  "type": "http",
  "kind": "web",
  "url": "https://shop.example.com/checkout",
  "enabled": false,
  "pausedByPlan": false,
  "state": "paused",
  "checkedAt": "2026-11-10T09:29:12.000Z",
  "latencyMs": 182,
  "statusCode": 200,
  "error": null,
  "incident": null,
  "checkInterval": 1,
  "alertAfterMinutes": 0,
  "categoryId": "cmh3k2x9a0002qv08cat00001",
  "category": {
    "id": "cmh3k2x9a0002qv08cat00001",
    "name": "Acme Ltd"
  },
  "statusPageId": "cmh3k2x9a0003qv08page0001",
  "escalationPolicyId": null,
  "pinned": false,
  "httpMethod": "GET",
  "requestHeaders": null,
  "requestBody": null,
  "keyword": "Pay now",
  "keywordMode": "contains",
  "jsonPath": null,
  "jsonExpected": null,
  "expectedStatusCodes": null,
  "maxLatencyMs": null,
  "dnsRecordType": "A",
  "dnsExpected": null,
  "pingMaxLoss": null,
  "udpPayload": null,
  "udpPayloadFormat": "text",
  "udpExpected": null,
  "mailTls": "starttls",
  "heartbeatGrace": 5,
  "heartbeatUrl": null,
  "checkSsl": true,
  "checkDomainExpiry": false,
  "ssl": {
    "valid": true,
    "expiresAt": "2027-01-20T23:59:59.000Z"
  },
  "domainExpiresAt": null,
  "emailAlerts": true,
  "alertEmails": null,
  "expiryAlerts": true,
  "createdAt": "2026-10-01T08:00:00.000Z",
  "updatedAt": "2026-11-09T14:12:00.000Z",
  "links": {
    "monitor": "https://heedery.com/admin/sites/cmh3k2x9a0001qv08abcd1234"
  }
}

Resume a monitor

POST/monitors/{id}/resume

scopewriteplanTeam and upIdempotent with a key

Starts checks again. Refused when the plan already runs as many monitors as it allows.

Needs: a token with the write scope, on the Team plan or above.

Path parameters

  • idstringrequired
    The record id.

Headers

  • Idempotency-Keystring
    Any unique string (a UUID). A retry with the same key and body within 24 hours gets the first answer instead of doing it twice.

    up to 255 characters

Returns

200The running monitor: a monitor object.

400
Bad request: invalid_request (A query parameter, the cursor or the JSON is malformed.)
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.); scope_required (The token only reads; this needs the write scope.); monitor_limit_reached (The plan’s monitors are all in use.); needs_plan (The workspace has no plan, so it runs no monitors.)
404
Not found: not_found (No such thing in this workspace.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
POST/monitors/{id}/resume
Response 200
{
  "id": "cmh3k2x9a0001qv08abcd1234",
  "name": "Shop checkout",
  "description": null,
  "type": "http",
  "kind": "web",
  "url": "https://shop.example.com/checkout",
  "enabled": true,
  "pausedByPlan": false,
  "state": "up",
  "checkedAt": "2026-11-10T09:29:12.000Z",
  "latencyMs": 182,
  "statusCode": 200,
  "error": null,
  "incident": null,
  "checkInterval": 1,
  "alertAfterMinutes": 0,
  "categoryId": "cmh3k2x9a0002qv08cat00001",
  "category": {
    "id": "cmh3k2x9a0002qv08cat00001",
    "name": "Acme Ltd"
  },
  "statusPageId": "cmh3k2x9a0003qv08page0001",
  "escalationPolicyId": null,
  "pinned": false,
  "httpMethod": "GET",
  "requestHeaders": null,
  "requestBody": null,
  "keyword": "Pay now",
  "keywordMode": "contains",
  "jsonPath": null,
  "jsonExpected": null,
  "expectedStatusCodes": null,
  "maxLatencyMs": null,
  "dnsRecordType": "A",
  "dnsExpected": null,
  "pingMaxLoss": null,
  "udpPayload": null,
  "udpPayloadFormat": "text",
  "udpExpected": null,
  "mailTls": "starttls",
  "heartbeatGrace": 5,
  "heartbeatUrl": null,
  "checkSsl": true,
  "checkDomainExpiry": false,
  "ssl": {
    "valid": true,
    "expiresAt": "2027-01-20T23:59:59.000Z"
  },
  "domainExpiresAt": null,
  "emailAlerts": true,
  "alertEmails": null,
  "expiryAlerts": true,
  "createdAt": "2026-10-01T08:00:00.000Z",
  "updatedAt": "2026-11-09T14:12:00.000Z",
  "links": {
    "monitor": "https://heedery.com/admin/sites/cmh3k2x9a0001qv08abcd1234"
  }
}

Uptime and response times

GET/monitors/{id}/metrics

scopereadplanPro and up

Per UTC day between from and to (30 days by default, at most 90, within your plan’s history): uptime, downtime, incidents, checks, average and 95th percentile response time, and the same for the whole range. Uptime counts incident time, as the status page does.

Needs: any token (read scope), on the Pro plan or above.

Path parameters

  • idstringrequired
    The record id.

Query parameters

  • fromstring

    matches ^\d{4}-\d{2}-\d{2}(T.*)?$

  • tostring

    matches ^\d{4}-\d{2}-\d{2}(T.*)?$

Returns

200The figures.

Show the response fields
  • monitorIdstringrequired
  • fromstringrequired
    First UTC day, inclusive.
  • tostringrequired
    Last UTC day, inclusive.
  • summaryobjectrequired
    Show 6 child fields
    • uptimePercentnumber · nullablerequired
      Average of the monitored days, as the status page counts it; null when no day was monitored.
    • downtimeMinutesintegerrequired
    • incidentsintegerrequired
      Incidents that overlapped the range.
    • checksintegerrequired
    • avgResponseMsinteger · nullablerequired
    • p95ResponseMsinteger · nullablerequired
  • daysarray of objectsrequired
    One entry per day, oldest first.
    Show 9 child fields
    • datestringrequired
      The UTC day.
    • monitoredbooleanrequired
      Checks ran that day (false before the monitor existed or while paused).
    • uptimePercentnumber · nullablerequired
      Share of the day it was up, from incident time; null when not monitored.
    • downtimeMinutesintegerrequired
    • incidentsintegerrequired
      Incidents that overlapped the day.
    • checksintegerrequired
    • failedChecksintegerrequired
    • avgResponseMsinteger · nullablerequired
    • p95ResponseMsinteger · nullablerequired
      95% of the day’s successful checks answered at or under this.
400
Bad request: invalid_request (A query parameter, the cursor or the JSON is malformed.)
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.)
404
Not found: not_found (No such thing in this workspace.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
GET/monitors/{id}/metrics
Response 200
{
  "monitorId": "cmh3k2x9a0001qv08abcd1234",
  "from": "2026-11-08",
  "to": "2026-11-09",
  "summary": {
    "uptimePercent": 99.931,
    "downtimeMinutes": 2,
    "incidents": 1,
    "checks": 2880,
    "avgResponseMs": 212,
    "p95ResponseMs": 480
  },
  "days": [
    {
      "date": "2026-11-08",
      "monitored": true,
      "uptimePercent": 100,
      "downtimeMinutes": 0,
      "incidents": 0,
      "checks": 1440,
      "failedChecks": 0,
      "avgResponseMs": 205,
      "p95ResponseMs": 460
    },
    {
      "date": "2026-11-09",
      "monitored": true,
      "uptimePercent": 99.86,
      "downtimeMinutes": 2,
      "incidents": 1,
      "checks": 1440,
      "failedChecks": 3,
      "avgResponseMs": 219,
      "p95ResponseMs": 500
    }
  ]
}
Resource

Incidents

Outages, from the first failed check to the recovery.

The incident object

Attributes

  • idstringrequired
    The incident.
  • statusstringrequired

    One ofopenresolved

  • monitorIdstringrequired
  • monitorobjectrequired
    Show 3 child fields
    • idstringrequired
    • namestringrequired
    • urlstringrequired
  • startedAtstring (ISO 8601)required
    The first failed check.
  • endedAtstring (ISO 8601) · nullablerequired
    When it was resolved; null while open.
  • durationSecondsintegerrequired
    So far, while open.
  • errorstring · nullablerequired
    What the check that opened it saw.
  • acknowledgedAtstring (ISO 8601) · nullablerequired
    When someone took it.
  • acknowledgedBystring · nullablerequired
    A name, an address, "Slack · #ops", or a token.
  • resolvedManuallybooleanrequired
    Closed by a person rather than by the checks.
  • endReasonstring · nullablerequired
    Why it ended without the monitor coming back: paused (someone paused the monitor) or plan (billing paused it). Null when the checks saw it recover or a person resolved it. No recovery alert goes out for a paused end; status page subscribers who were emailed about the outage get a short “monitoring paused” email instead.

    One ofpausedplan

The incident object
{
  "id": "cmh3k2x9a0001qv08abcd1234",
  "status": "open",
  "monitorId": "string",
  "monitor": {
    "id": "string",
    "name": "string",
    "url": "string"
  },
  "startedAt": "2026-11-10T09:30:00.000Z",
  "endedAt": "2026-11-10T09:30:00.000Z",
  "durationSeconds": 0,
  "error": "string",
  "acknowledgedAt": "2026-11-10T09:30:00.000Z",
  "acknowledgedBy": "string",
  "resolvedManually": true,
  "endReason": "paused"
}

List incidents

GET/incidents

scopereadplanPro and up

Incidents across the workspace, newest first. Filter by status, monitor and when they started.

Needs: any token (read scope), on the Pro plan or above.

Query parameters

  • statusstring

    One ofopenresolved

  • monitorstring

    up to 100 characters

  • fromstring
  • tostring
  • limitinteger
    How many items to return, 1 to 100.

    Default 501 to 100

  • cursorstring
    The nextCursor of the previous page; leave out for the first page. Opaque: do not build or parse it.

Returns

200A page of incidents.

Show the response fields
  • dataarray of objectsrequired
    Show 12 child fields
    • idstringrequired
      The incident.
    • statusstringrequired

      One ofopenresolved

    • monitorIdstringrequired
    • monitorobjectrequired
      Show 3 child fields
      • idstringrequired
      • namestringrequired
      • urlstringrequired
    • startedAtstring (ISO 8601)required
      The first failed check.
    • endedAtstring (ISO 8601) · nullablerequired
      When it was resolved; null while open.
    • durationSecondsintegerrequired
      So far, while open.
    • errorstring · nullablerequired
      What the check that opened it saw.
    • acknowledgedAtstring (ISO 8601) · nullablerequired
      When someone took it.
    • acknowledgedBystring · nullablerequired
      A name, an address, "Slack · #ops", or a token.
    • resolvedManuallybooleanrequired
      Closed by a person rather than by the checks.
    • endReasonstring · nullablerequired
      Why it ended without the monitor coming back: paused (someone paused the monitor) or plan (billing paused it). Null when the checks saw it recover or a person resolved it. No recovery alert goes out for a paused end; status page subscribers who were emailed about the outage get a short “monitoring paused” email instead.

      One ofpausedplan

  • nextCursorstring · nullablerequired
    Pass as cursor to get the next page; null on the last page.
400
Bad request: invalid_request (A query parameter, the cursor or the JSON is malformed.)
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
GET/incidents
Response 200
{
  "data": [
    {
      "id": "cmh3k2x9a0009qv08inc00001",
      "status": "open",
      "monitorId": "cmh3k2x9a0001qv08abcd1234",
      "monitor": {
        "id": "cmh3k2x9a0001qv08abcd1234",
        "name": "Shop checkout",
        "url": "https://shop.example.com/checkout"
      },
      "startedAt": "2026-11-10T09:12:00.000Z",
      "endedAt": null,
      "durationSeconds": 1080,
      "error": "HTTP 503",
      "acknowledgedAt": null,
      "acknowledgedBy": null,
      "resolvedManually": false,
      "endReason": null
    }
  ],
  "nextCursor": null
}

Get an incident

GET/incidents/{id}

scopereadplanPro and up

One incident with its timeline (first failure, alerts, escalation, acknowledgement, comments, resolution), what the failing check saw, and a deploy that shortly preceded it.

Needs: any token (read scope), on the Pro plan or above.

Path parameters

  • idstringrequired
    The record id.

Returns

200The incident.

Show the response fields
  • idstringrequired
    The incident.
  • statusstringrequired

    One ofopenresolved

  • monitorIdstringrequired
  • monitorobjectrequired
    Show 3 child fields
    • idstringrequired
    • namestringrequired
    • urlstringrequired
  • startedAtstring (ISO 8601)required
    The first failed check.
  • endedAtstring (ISO 8601) · nullablerequired
    When it was resolved; null while open.
  • durationSecondsintegerrequired
    So far, while open.
  • errorstring · nullablerequired
    What the check that opened it saw.
  • acknowledgedAtstring (ISO 8601) · nullablerequired
    When someone took it.
  • acknowledgedBystring · nullablerequired
    A name, an address, "Slack · #ops", or a token.
  • resolvedManuallybooleanrequired
    Closed by a person rather than by the checks.
  • endReasonstring · nullablerequired
    Why it ended without the monitor coming back: paused (someone paused the monitor) or plan (billing paused it). Null when the checks saw it recover or a person resolved it. No recovery alert goes out for a paused end; status page subscribers who were emailed about the outage get a short “monitoring paused” email instead.

    One ofpausedplan

  • openedAtstring (ISO 8601)required
    When the incident opened (after the confirming checks and any alert delay).
  • failedRegionsarray of stringsrequired
    Check regions that saw the failure, the main first.
  • evidenceobject · nullablerequired
    What the check that opened it saw; null for incidents from before evidence was recorded.
    Show 11 child fields
    • capturedAtstring (ISO 8601)required
      When the failing check ran.
    • categorystringrequired
      What kind of failure: dns, connect, tls, timeout, httpstatus, keywordmissing…
    • summarystringrequired
      The failure in one plain sentence.
    • notesarray of stringsrequired
    • checkTypestringrequired
    • targetstringrequired
    • statusCodeinteger · nullablerequired
    • errorstring · nullablerequired
    • totalMsinteger · nullablerequired
    • phasesarray of objectsrequired
      Show 4 child fields
      • keystringrequired
      • labelstringrequired
      • msnumberrequired
      • failedbooleanrequired
    • screenshotUrlstring · nullablerequired
      A signed link to the screenshot of the page, when one was taken (Pro and up).
  • deployBeforeobject · nullablerequired
    A deploy reported up to 30 minutes before it began, if any.
    Show 4 child fields
    • idstringrequired
    • versionstringrequired
    • deployedAtstring (ISO 8601)required
      When it went live.
    • minutesBeforenumberrequired
  • timelinearray of objectsrequired
    What happened, oldest first.
    Show 4 child fields
    • atstring (ISO 8601)required
      When.
    • kindstringrequired

      One offirst_failureopenednotifiedescalatedacknowledgedcommentresolvedpaused

    • titlestringrequired
    • detailstring · nullablerequired
  • commentsarray of objectsrequired
    Show 5 child fields
    • idstringrequired
    • authorstringrequired
    • bodystringrequired
    • createdAtstring (ISO 8601)required
      When it was written.
    • editedAtstring (ISO 8601) · nullablerequired
      When it was last changed.
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.)
404
Not found: not_found (No such thing in this workspace.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
GET/incidents/{id}
Response 200
{
  "id": "cmh3k2x9a0009qv08inc00001",
  "status": "open",
  "monitorId": "cmh3k2x9a0001qv08abcd1234",
  "monitor": {
    "id": "cmh3k2x9a0001qv08abcd1234",
    "name": "Shop checkout",
    "url": "https://shop.example.com/checkout"
  },
  "startedAt": "2026-11-10T09:12:00.000Z",
  "endedAt": null,
  "durationSeconds": 1080,
  "error": "HTTP 503",
  "acknowledgedAt": null,
  "acknowledgedBy": null,
  "resolvedManually": false,
  "endReason": null,
  "openedAt": "2026-11-10T09:14:00.000Z",
  "failedRegions": [
    "eu-central",
    "us-east"
  ],
  "evidence": {
    "capturedAt": "2026-11-10T09:12:00.000Z",
    "category": "http_status",
    "summary": "The server answered 503 Service Unavailable.",
    "notes": [
      "The page title was \"Maintenance\"."
    ],
    "checkType": "http",
    "target": "https://shop.example.com/checkout",
    "statusCode": 503,
    "error": "HTTP 503",
    "totalMs": 412,
    "phases": [
      {
        "key": "dns",
        "label": "DNS",
        "ms": 12,
        "failed": false
      },
      {
        "key": "connect",
        "label": "Connect",
        "ms": 30,
        "failed": false
      },
      {
        "key": "tls",
        "label": "TLS",
        "ms": 60,
        "failed": false
      },
      {
        "key": "firstByte",
        "label": "First byte",
        "ms": 300,
        "failed": false
      },
      {
        "key": "transfer",
        "label": "Download",
        "ms": 10,
        "failed": false
      }
    ],
    "screenshotUrl": null
  },
  "deployBefore": {
    "id": "cmh3k2x9a0010qv08dep00001",
    "version": "v1.4.2",
    "deployedAt": "2026-11-10T09:05:00.000Z",
    "minutesBefore": 7
  },
  "timeline": [
    {
      "at": "2026-11-10T09:12:00.000Z",
      "kind": "first_failure",
      "title": "First failed check",
      "detail": "HTTP 503"
    },
    {
      "at": "2026-11-10T09:14:00.000Z",
      "kind": "opened",
      "title": "Incident opened",
      "detail": "After 2 failed checks"
    }
  ],
  "comments": []
}

Acknowledge an incident

POST/incidents/{id}/acknowledge

scopewriteplanTeam and upIdempotent with a key

"We are on it": repeat alerts and escalation stop. The timeline names the token. Acknowledging one someone already took is not an error (result: "already").

Needs: a token with the write scope, on the Team plan or above.

Path parameters

  • idstringrequired
    The record id.

Headers

  • Idempotency-Keystring
    Any unique string (a UUID). A retry with the same key and body within 24 hours gets the first answer instead of doing it twice.

    up to 255 characters

Returns

200Acknowledged.

Show the response fields
  • resultstringrequired
    done: acknowledged now; already: someone was first (see incident.acknowledgedBy).

    One ofdonealready

  • incidentobjectrequired
    Show 18 child fields
    • idstringrequired
      The incident.
    • statusstringrequired

      One ofopenresolved

    • monitorIdstringrequired
    • monitorobjectrequired
      Show 3 child fields
      • idstringrequired
      • namestringrequired
      • urlstringrequired
    • startedAtstring (ISO 8601)required
      The first failed check.
    • endedAtstring (ISO 8601) · nullablerequired
      When it was resolved; null while open.
    • durationSecondsintegerrequired
      So far, while open.
    • errorstring · nullablerequired
      What the check that opened it saw.
    • acknowledgedAtstring (ISO 8601) · nullablerequired
      When someone took it.
    • acknowledgedBystring · nullablerequired
      A name, an address, "Slack · #ops", or a token.
    • resolvedManuallybooleanrequired
      Closed by a person rather than by the checks.
    • endReasonstring · nullablerequired
      Why it ended without the monitor coming back: paused (someone paused the monitor) or plan (billing paused it). Null when the checks saw it recover or a person resolved it. No recovery alert goes out for a paused end; status page subscribers who were emailed about the outage get a short “monitoring paused” email instead.

      One ofpausedplan

    • openedAtstring (ISO 8601)required
      When the incident opened (after the confirming checks and any alert delay).
    • failedRegionsarray of stringsrequired
      Check regions that saw the failure, the main first.
    • evidenceobject · nullablerequired
      What the check that opened it saw; null for incidents from before evidence was recorded.
      Show 11 child fields
      • capturedAtstring (ISO 8601)required
        When the failing check ran.
      • categorystringrequired
        What kind of failure: dns, connect, tls, timeout, httpstatus, keywordmissing…
      • summarystringrequired
        The failure in one plain sentence.
      • notesarray of stringsrequired
      • checkTypestringrequired
      • targetstringrequired
      • statusCodeinteger · nullablerequired
      • errorstring · nullablerequired
      • totalMsinteger · nullablerequired
      • phasesarray of objectsrequired
        Show 4 child fields
        • keystringrequired
        • labelstringrequired
        • msnumberrequired
        • failedbooleanrequired
      • screenshotUrlstring · nullablerequired
        A signed link to the screenshot of the page, when one was taken (Pro and up).
    • deployBeforeobject · nullablerequired
      A deploy reported up to 30 minutes before it began, if any.
      Show 4 child fields
      • idstringrequired
      • versionstringrequired
      • deployedAtstring (ISO 8601)required
        When it went live.
      • minutesBeforenumberrequired
    • timelinearray of objectsrequired
      What happened, oldest first.
      Show 4 child fields
      • atstring (ISO 8601)required
        When.
      • kindstringrequired

        One offirst_failureopenednotifiedescalatedacknowledgedcommentresolvedpaused

      • titlestringrequired
      • detailstring · nullablerequired
    • commentsarray of objectsrequired
      Show 5 child fields
      • idstringrequired
      • authorstringrequired
      • bodystringrequired
      • createdAtstring (ISO 8601)required
        When it was written.
      • editedAtstring (ISO 8601) · nullablerequired
        When it was last changed.
400
Bad request: invalid_request (A query parameter, the cursor or the JSON is malformed.)
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.); scope_required (The token only reads; this needs the write scope.)
404
Not found: not_found (No such thing in this workspace.)
409
Conflict: incident_resolved (The incident is already resolved.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
POST/incidents/{id}/acknowledge
Response 200
{
  "result": "done",
  "incident": {
    "id": "cmh3k2x9a0009qv08inc00001",
    "status": "open",
    "monitorId": "cmh3k2x9a0001qv08abcd1234",
    "monitor": {
      "id": "cmh3k2x9a0001qv08abcd1234",
      "name": "Shop checkout",
      "url": "https://shop.example.com/checkout"
    },
    "startedAt": "2026-11-10T09:12:00.000Z",
    "endedAt": null,
    "durationSeconds": 1080,
    "error": "HTTP 503",
    "acknowledgedAt": "2026-11-10T09:20:00.000Z",
    "acknowledgedBy": "CRM (API)",
    "resolvedManually": false,
    "endReason": null,
    "openedAt": "2026-11-10T09:14:00.000Z",
    "failedRegions": [
      "eu-central",
      "us-east"
    ],
    "evidence": {
      "capturedAt": "2026-11-10T09:12:00.000Z",
      "category": "http_status",
      "summary": "The server answered 503 Service Unavailable.",
      "notes": [
        "The page title was \"Maintenance\"."
      ],
      "checkType": "http",
      "target": "https://shop.example.com/checkout",
      "statusCode": 503,
      "error": "HTTP 503",
      "totalMs": 412,
      "phases": [
        {
          "key": "dns",
          "label": "DNS",
          "ms": 12,
          "failed": false
        },
        {
          "key": "connect",
          "label": "Connect",
          "ms": 30,
          "failed": false
        },
        {
          "key": "tls",
          "label": "TLS",
          "ms": 60,
          "failed": false
        },
        {
          "key": "firstByte",
          "label": "First byte",
          "ms": 300,
          "failed": false
        },
        {
          "key": "transfer",
          "label": "Download",
          "ms": 10,
          "failed": false
        }
      ],
      "screenshotUrl": null
    },
    "deployBefore": {
      "id": "cmh3k2x9a0010qv08dep00001",
      "version": "v1.4.2",
      "deployedAt": "2026-11-10T09:05:00.000Z",
      "minutesBefore": 7
    },
    "timeline": [
      {
        "at": "2026-11-10T09:12:00.000Z",
        "kind": "first_failure",
        "title": "First failed check",
        "detail": "HTTP 503"
      },
      {
        "at": "2026-11-10T09:14:00.000Z",
        "kind": "opened",
        "title": "Incident opened",
        "detail": "After 2 failed checks"
      }
    ],
    "comments": []
  }
}

Comment on an incident

POST/incidents/{id}/comments

scopewriteplanTeam and upIdempotent with a key

Adds an internal note to the incident’s timeline, signed with the token’s name. Status page subscribers never see it.

Needs: a token with the write scope, on the Team plan or above.

Path parameters

  • idstringrequired
    The record id.

Headers

  • Idempotency-Keystring
    Any unique string (a UUID). A retry with the same key and body within 24 hours gets the first answer instead of doing it twice.

    up to 255 characters

Body

JSON
  • bodystringrequired
    The note, up to 2000 characters. Internal: it is never shown on a status page.

    1 to 2000 characters

Returns

201The incident with the new comment.

Show the response fields
  • idstringrequired
    The incident.
  • statusstringrequired

    One ofopenresolved

  • monitorIdstringrequired
  • monitorobjectrequired
    Show 3 child fields
    • idstringrequired
    • namestringrequired
    • urlstringrequired
  • startedAtstring (ISO 8601)required
    The first failed check.
  • endedAtstring (ISO 8601) · nullablerequired
    When it was resolved; null while open.
  • durationSecondsintegerrequired
    So far, while open.
  • errorstring · nullablerequired
    What the check that opened it saw.
  • acknowledgedAtstring (ISO 8601) · nullablerequired
    When someone took it.
  • acknowledgedBystring · nullablerequired
    A name, an address, "Slack · #ops", or a token.
  • resolvedManuallybooleanrequired
    Closed by a person rather than by the checks.
  • endReasonstring · nullablerequired
    Why it ended without the monitor coming back: paused (someone paused the monitor) or plan (billing paused it). Null when the checks saw it recover or a person resolved it. No recovery alert goes out for a paused end; status page subscribers who were emailed about the outage get a short “monitoring paused” email instead.

    One ofpausedplan

  • openedAtstring (ISO 8601)required
    When the incident opened (after the confirming checks and any alert delay).
  • failedRegionsarray of stringsrequired
    Check regions that saw the failure, the main first.
  • evidenceobject · nullablerequired
    What the check that opened it saw; null for incidents from before evidence was recorded.
    Show 11 child fields
    • capturedAtstring (ISO 8601)required
      When the failing check ran.
    • categorystringrequired
      What kind of failure: dns, connect, tls, timeout, httpstatus, keywordmissing…
    • summarystringrequired
      The failure in one plain sentence.
    • notesarray of stringsrequired
    • checkTypestringrequired
    • targetstringrequired
    • statusCodeinteger · nullablerequired
    • errorstring · nullablerequired
    • totalMsinteger · nullablerequired
    • phasesarray of objectsrequired
      Show 4 child fields
      • keystringrequired
      • labelstringrequired
      • msnumberrequired
      • failedbooleanrequired
    • screenshotUrlstring · nullablerequired
      A signed link to the screenshot of the page, when one was taken (Pro and up).
  • deployBeforeobject · nullablerequired
    A deploy reported up to 30 minutes before it began, if any.
    Show 4 child fields
    • idstringrequired
    • versionstringrequired
    • deployedAtstring (ISO 8601)required
      When it went live.
    • minutesBeforenumberrequired
  • timelinearray of objectsrequired
    What happened, oldest first.
    Show 4 child fields
    • atstring (ISO 8601)required
      When.
    • kindstringrequired

      One offirst_failureopenednotifiedescalatedacknowledgedcommentresolvedpaused

    • titlestringrequired
    • detailstring · nullablerequired
  • commentsarray of objectsrequired
    Show 5 child fields
    • idstringrequired
    • authorstringrequired
    • bodystringrequired
    • createdAtstring (ISO 8601)required
      When it was written.
    • editedAtstring (ISO 8601) · nullablerequired
      When it was last changed.
400
Bad request: invalid_request (A query parameter, the cursor or the JSON is malformed.)
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.); scope_required (The token only reads; this needs the write scope.)
404
Not found: not_found (No such thing in this workspace.)
409
Conflict: idempotency_in_progress (A request with this Idempotency-Key is still running.)
422
Unprocessable: validation_failed (A field is wrong; details lists them.); idempotency_key_reused (The Idempotency-Key was used with a different request.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
POST/incidents/{id}/comments
Response 201
{
  "id": "cmh3k2x9a0001qv08abcd1234",
  "status": "open",
  "monitorId": "string",
  "monitor": {
    "id": "string",
    "name": "string",
    "url": "string"
  },
  "startedAt": "2026-11-10T09:30:00.000Z",
  "endedAt": "2026-11-10T09:30:00.000Z",
  "durationSeconds": 0,
  "error": "string",
  "acknowledgedAt": "2026-11-10T09:30:00.000Z",
  "acknowledgedBy": "string",
  "resolvedManually": true,
  "endReason": "paused",
  "openedAt": "2026-11-10T09:30:00.000Z",
  "failedRegions": [
    "string"
  ],
  "evidence": {
    "capturedAt": "2026-11-10T09:30:00.000Z",
    "category": "string",
    "summary": "string",
    "notes": [
      "string"
    ],
    "checkType": "string",
    "target": "string",
    "statusCode": 0,
    "error": "string",
    "totalMs": 0,
    "phases": [
      {
        "key": "string",
        "label": "string",
        "ms": 0,
        "failed": true
      }
    ],
    "screenshotUrl": "string"
  },
  "deployBefore": {
    "id": "string",
    "version": "string",
    "deployedAt": "2026-11-10T09:30:00.000Z",
    "minutesBefore": 0
  },
  "timeline": [
    {
      "at": "2026-11-10T09:30:00.000Z",
      "kind": "first_failure",
      "title": "string",
      "detail": "string"
    }
  ],
  "comments": [
    {
      "id": "string",
      "author": "string",
      "body": "string",
      "createdAt": "2026-11-10T09:30:00.000Z",
      "editedAt": "2026-11-10T09:30:00.000Z"
    }
  ]
}

List maintenance windows

GET/maintenance

scopereadplanPro and up

Maintenance windows, latest start first. While one runs, its monitors’ alerts are held and the status page says so.

Needs: any token (read scope), on the Pro plan or above.

Query parameters

  • phasestring

    One ofupcomingactiveendedcancelled

  • limitinteger
    How many items to return, 1 to 100.

    Default 501 to 100

  • cursorstring
    The nextCursor of the previous page; leave out for the first page. Opaque: do not build or parse it.

Returns

200A page of windows.

Show the response fields
  • dataarray of objectsrequired
    Show 11 child fields
    • idstringrequired
      The window.
    • titlestringrequired
    • messagestring · nullablerequired
    • startsAtstring (ISO 8601)required
      When it starts.
    • endsAtstring (ISO 8601)required
      When it ends.
    • phasestringrequired

      One ofupcomingactiveendedcancelled

    • cancelledAtstring (ISO 8601) · nullablerequired
      When it was called off before it began.
    • notifiedAtstring (ISO 8601) · nullablerequired
      When status page subscribers were told about it.
    • createdAtstring (ISO 8601)required
      When it was scheduled.
    • createdBystring · nullablerequired
    • monitorsarray of objectsrequired
      Show 2 child fields
      • idstringrequired
      • namestringrequired
  • nextCursorstring · nullablerequired
    Pass as cursor to get the next page; null on the last page.
400
Bad request: invalid_request (A query parameter, the cursor or the JSON is malformed.)
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
GET/maintenance
Response 200
{
  "data": [
    {
      "id": "cmh3k2x9a0011qv08mnt00001",
      "title": "Database upgrade",
      "message": "Checkout may be slow for a few minutes.",
      "startsAt": "2026-11-12T22:00:00.000Z",
      "endsAt": "2026-11-12T23:00:00.000Z",
      "phase": "upcoming",
      "cancelledAt": null,
      "notifiedAt": "2026-11-10T09:31:00.000Z",
      "createdAt": "2026-11-10T09:30:00.000Z",
      "createdBy": null,
      "monitors": [
        {
          "id": "cmh3k2x9a0001qv08abcd1234",
          "name": "Shop checkout"
        }
      ]
    }
  ],
  "nextCursor": null
}

Schedule maintenance

POST/maintenance

scopewriteplanTeam and upIdempotent with a key

Schedules a window, or starts one now when startsAt is left out. Subscribers of the affected status pages are told by email.

Needs: a token with the write scope, on the Team plan or above.

Headers

  • Idempotency-Keystring
    Any unique string (a UUID). A retry with the same key and body within 24 hours gets the first answer instead of doing it twice.

    up to 255 characters

Body

JSON
  • titlestringrequired

    1 to 120 characters

  • messagestring · nullable
    Shown on the status page and in the subscriber email.

    up to 2000 characters

  • endsAtstring (ISO 8601)required
    When it ends; at most 14 days after the start.
  • monitorIdsarray of stringsrequired
    The monitors it covers. Their alerts are held while it runs.

    1 to 1000 items

  • startsAtstring (ISO 8601)
    When it starts; now by default.

Returns

201The window.

Show the response fields
  • idstringrequired
    The window.
  • titlestringrequired
  • messagestring · nullablerequired
  • startsAtstring (ISO 8601)required
    When it starts.
  • endsAtstring (ISO 8601)required
    When it ends.
  • phasestringrequired

    One ofupcomingactiveendedcancelled

  • cancelledAtstring (ISO 8601) · nullablerequired
    When it was called off before it began.
  • notifiedAtstring (ISO 8601) · nullablerequired
    When status page subscribers were told about it.
  • createdAtstring (ISO 8601)required
    When it was scheduled.
  • createdBystring · nullablerequired
  • monitorsarray of objectsrequired
    Show 2 child fields
    • idstringrequired
    • namestringrequired
400
Bad request: invalid_request (A query parameter, the cursor or the JSON is malformed.)
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.); scope_required (The token only reads; this needs the write scope.)
409
Conflict: idempotency_in_progress (A request with this Idempotency-Key is still running.)
422
Unprocessable: validation_failed (A field is wrong; details lists them.); idempotency_key_reused (The Idempotency-Key was used with a different request.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
POST/maintenance
Response 201
{
  "id": "cmh3k2x9a0011qv08mnt00001",
  "title": "Database upgrade",
  "message": "Checkout may be slow for a few minutes.",
  "startsAt": "2026-11-12T22:00:00.000Z",
  "endsAt": "2026-11-12T23:00:00.000Z",
  "phase": "upcoming",
  "cancelledAt": null,
  "notifiedAt": "2026-11-10T09:31:00.000Z",
  "createdAt": "2026-11-10T09:30:00.000Z",
  "createdBy": null,
  "monitors": [
    {
      "id": "cmh3k2x9a0001qv08abcd1234",
      "name": "Shop checkout"
    }
  ]
}

Get a maintenance window

GET/maintenance/{id}

scopereadplanPro and up

One window and the monitors it covers.

Needs: any token (read scope), on the Pro plan or above.

Path parameters

  • idstringrequired
    The record id.

Returns

200The window.

Show the response fields
  • idstringrequired
    The window.
  • titlestringrequired
  • messagestring · nullablerequired
  • startsAtstring (ISO 8601)required
    When it starts.
  • endsAtstring (ISO 8601)required
    When it ends.
  • phasestringrequired

    One ofupcomingactiveendedcancelled

  • cancelledAtstring (ISO 8601) · nullablerequired
    When it was called off before it began.
  • notifiedAtstring (ISO 8601) · nullablerequired
    When status page subscribers were told about it.
  • createdAtstring (ISO 8601)required
    When it was scheduled.
  • createdBystring · nullablerequired
  • monitorsarray of objectsrequired
    Show 2 child fields
    • idstringrequired
    • namestringrequired
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.)
404
Not found: not_found (No such thing in this workspace.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
GET/maintenance/{id}
Response 200
{
  "id": "cmh3k2x9a0011qv08mnt00001",
  "title": "Database upgrade",
  "message": "Checkout may be slow for a few minutes.",
  "startsAt": "2026-11-12T22:00:00.000Z",
  "endsAt": "2026-11-12T23:00:00.000Z",
  "phase": "upcoming",
  "cancelledAt": null,
  "notifiedAt": "2026-11-10T09:31:00.000Z",
  "createdAt": "2026-11-10T09:30:00.000Z",
  "createdBy": null,
  "monitors": [
    {
      "id": "cmh3k2x9a0001qv08abcd1234",
      "name": "Shop checkout"
    }
  ]
}

Update a maintenance window

PATCH/maintenance/{id}

scopewriteplanTeam and up

Changes a window that has not ended (a running one can be extended). Subscribers who were told about it hear about a new time or new monitors once.

Needs: a token with the write scope, on the Team plan or above.

Path parameters

  • idstringrequired
    The record id.

Body

JSON
  • titlestring

    1 to 120 characters

  • messagestring · nullable
    Shown on the status page and in the subscriber email.

    up to 2000 characters

  • startsAtstring (ISO 8601)
  • endsAtstring (ISO 8601)
    When it ends; at most 14 days after the start.
  • monitorIdsarray of strings
    The monitors it covers. Their alerts are held while it runs.

    1 to 1000 items

Returns

200The window as it is now.

Show the response fields
  • idstringrequired
    The window.
  • titlestringrequired
  • messagestring · nullablerequired
  • startsAtstring (ISO 8601)required
    When it starts.
  • endsAtstring (ISO 8601)required
    When it ends.
  • phasestringrequired

    One ofupcomingactiveendedcancelled

  • cancelledAtstring (ISO 8601) · nullablerequired
    When it was called off before it began.
  • notifiedAtstring (ISO 8601) · nullablerequired
    When status page subscribers were told about it.
  • createdAtstring (ISO 8601)required
    When it was scheduled.
  • createdBystring · nullablerequired
  • monitorsarray of objectsrequired
    Show 2 child fields
    • idstringrequired
    • namestringrequired
400
Bad request: invalid_request (A query parameter, the cursor or the JSON is malformed.)
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.); scope_required (The token only reads; this needs the write scope.)
404
Not found: not_found (No such thing in this workspace.)
409
Conflict: window_closed (The window has ended or was cancelled.)
422
Unprocessable: validation_failed (A field is wrong; details lists them.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
PATCH/maintenance/{id}
Response 200
{
  "id": "cmh3k2x9a0011qv08mnt00001",
  "title": "Database upgrade",
  "message": "Checkout may be slow for a few minutes.",
  "startsAt": "2026-11-12T22:00:00.000Z",
  "endsAt": "2026-11-12T23:00:00.000Z",
  "phase": "upcoming",
  "cancelledAt": null,
  "notifiedAt": "2026-11-10T09:31:00.000Z",
  "createdAt": "2026-11-10T09:30:00.000Z",
  "createdBy": null,
  "monitors": [
    {
      "id": "cmh3k2x9a0001qv08abcd1234",
      "name": "Shop checkout"
    }
  ]
}

Delete a maintenance window

DEL/maintenance/{id}

scopewriteplanTeam and up

Removes a window in any phase. One that is running ends now and one that has not started is called off first; subscribers who were told hear that before it goes.

Needs: a token with the write scope, on the Team plan or above.

Path parameters

  • idstringrequired
    The record id.

Returns

200It is gone.

Show the response fields
  • idstringrequired
  • deletedbooleanrequired

    Always true

400
Bad request: invalid_request (A query parameter, the cursor or the JSON is malformed.)
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.); scope_required (The token only reads; this needs the write scope.)
404
Not found: not_found (No such thing in this workspace.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
DEL/maintenance/{id}
Response 200
{
  "id": "cmh3k2x9a0011qv08mnt00001",
  "deleted": true
}

End maintenance now

POST/maintenance/{id}/end

scopewriteplanTeam and upIdempotent with a key

Ends a running window early: alerts resume, subscribers who were told hear it is over.

Needs: a token with the write scope, on the Team plan or above.

Path parameters

  • idstringrequired
    The record id.

Headers

  • Idempotency-Keystring
    Any unique string (a UUID). A retry with the same key and body within 24 hours gets the first answer instead of doing it twice.

    up to 255 characters

Returns

200The ended window.

Show the response fields
  • idstringrequired
    The window.
  • titlestringrequired
  • messagestring · nullablerequired
  • startsAtstring (ISO 8601)required
    When it starts.
  • endsAtstring (ISO 8601)required
    When it ends.
  • phasestringrequired

    One ofupcomingactiveendedcancelled

  • cancelledAtstring (ISO 8601) · nullablerequired
    When it was called off before it began.
  • notifiedAtstring (ISO 8601) · nullablerequired
    When status page subscribers were told about it.
  • createdAtstring (ISO 8601)required
    When it was scheduled.
  • createdBystring · nullablerequired
  • monitorsarray of objectsrequired
    Show 2 child fields
    • idstringrequired
    • namestringrequired
400
Bad request: invalid_request (A query parameter, the cursor or the JSON is malformed.)
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.); scope_required (The token only reads; this needs the write scope.)
404
Not found: not_found (No such thing in this workspace.)
409
Conflict: not_running (The window is not running.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
POST/maintenance/{id}/end
Response 200
{
  "id": "cmh3k2x9a0011qv08mnt00001",
  "title": "Database upgrade",
  "message": "Checkout may be slow for a few minutes.",
  "startsAt": "2026-11-12T22:00:00.000Z",
  "endsAt": "2026-11-12T23:00:00.000Z",
  "phase": "ended",
  "cancelledAt": null,
  "notifiedAt": "2026-11-10T09:31:00.000Z",
  "createdAt": "2026-11-10T09:30:00.000Z",
  "createdBy": null,
  "monitors": [
    {
      "id": "cmh3k2x9a0001qv08abcd1234",
      "name": "Shop checkout"
    }
  ]
}
Resource

Deploys

Releases marked on the charts and named on incidents.

The deploy object

Attributes

  • idstringrequired
    The deploy.
  • versionstringrequired
  • commitstring · nullablerequired
  • environmentstring · nullablerequired
  • descriptionstring · nullablerequired
  • urlstring · nullablerequired
  • sourcestring · nullablerequired
    The token that reported it.
  • deployedAtstring (ISO 8601)required
    When it went live.
  • createdAtstring (ISO 8601)required
    When it was reported.
  • monitorIdsarray of stringsrequired
    The monitors it is about; empty = all of them.
The deploy object
{
  "id": "cmh3k2x9a0001qv08abcd1234",
  "version": "string",
  "commit": "string",
  "environment": "string",
  "description": "string",
  "url": "string",
  "source": "string",
  "deployedAt": "2026-11-10T09:30:00.000Z",
  "createdAt": "2026-11-10T09:30:00.000Z",
  "monitorIds": [
    "string"
  ]
}

List deploys

GET/deploys

scopereadplanPro and up

Deploys reported by CI or the API, newest first: the markers on the response-time charts. Pro and above.

Needs: any token (read scope), on the Pro plan or above.

Query parameters

  • monitorstring

    up to 100 characters

  • fromstring
  • tostring
  • limitinteger
    How many items to return, 1 to 100.

    Default 501 to 100

  • cursorstring
    The nextCursor of the previous page; leave out for the first page. Opaque: do not build or parse it.

Returns

200A page of deploys.

Show the response fields
  • dataarray of objectsrequired
    Show 10 child fields
    • idstringrequired
      The deploy.
    • versionstringrequired
    • commitstring · nullablerequired
    • environmentstring · nullablerequired
    • descriptionstring · nullablerequired
    • urlstring · nullablerequired
    • sourcestring · nullablerequired
      The token that reported it.
    • deployedAtstring (ISO 8601)required
      When it went live.
    • createdAtstring (ISO 8601)required
      When it was reported.
    • monitorIdsarray of stringsrequired
      The monitors it is about; empty = all of them.
  • nextCursorstring · nullablerequired
    Pass as cursor to get the next page; null on the last page.
400
Bad request: invalid_request (A query parameter, the cursor or the JSON is malformed.)
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
GET/deploys
Response 200
{
  "data": [
    {
      "id": "cmh3k2x9a0010qv08dep00001",
      "version": "v1.4.2",
      "commit": "9f2c1ab",
      "environment": "production",
      "description": null,
      "url": null,
      "source": "GitHub Actions",
      "deployedAt": "2026-11-10T09:05:00.000Z",
      "createdAt": "2026-11-10T09:05:02.000Z",
      "monitorIds": [
        "cmh3k2x9a0001qv08abcd1234"
      ]
    }
  ],
  "nextCursor": null
}

Report a deploy

POST/deploys

scopewriteplanTeam and upIdempotent with a key

Marks a release on the charts; an incident that starts within 30 minutes names it. The same as the CI webhook (POST /api/deploys with a deploy token), with an API token instead.

Needs: a token with the write scope, on the Team plan or above.

Headers

  • Idempotency-Keystring
    Any unique string (a UUID). A retry with the same key and body within 24 hours gets the first answer instead of doing it twice.

    up to 255 characters

Body

JSON
  • versionstringrequired
    What shipped: a tag, release name or ref.

    1 to 100 characters

  • commitstring · nullable
    The commit sha (4 to 64 hex characters).

    up to 64 characters

  • environmentstring · nullable

    up to 40 characters

  • descriptionstring · nullable

    up to 500 characters

  • urlstring · nullable
    A link to the release, the pipeline run or the diff.

    up to 2000 characters

  • monitorsarray of strings · nullable
    The monitors it is about, by id, host or URL; leave out for all of them.

    up to 100 items

  • deployedAtstring or number
    When it went live: an ISO time or a Unix timestamp; now by default, at most 30 days back.

Returns

201The deploy: a deploy object.

400
Bad request: invalid_request (A query parameter, the cursor or the JSON is malformed.)
401
Unauthorized: unauthorized (No token, or an unknown one.)
403
Forbidden: plan_required (The plan does not include this: the API needs Pro, writes need Team.); scope_required (The token only reads; this needs the write scope.)
409
Conflict: idempotency_in_progress (A request with this Idempotency-Key is still running.)
422
Unprocessable: validation_failed (A field is wrong; details lists them.); idempotency_key_reused (The Idempotency-Key was used with a different request.)
429
Too many requests: rate_limited (Too many requests; see Retry-After.)
500
Server error: internal_error (Something broke on our side.)
POST/deploys
Response 201
{
  "id": "cmh3k2x9a0010qv08dep00001",
  "version": "v1.4.2",
  "commit": "9f2c1ab",
  "environment": "production",
  "description": null,
  "url": null,
  "source": "GitHub Actions",
  "deployedAt": "2026-11-10T09:05:00.000Z",
  "createdAt": "2026-11-10T09:05:02.000Z",
  "monitorIds": [
    "cmh3k2x9a0001qv08abcd1234"
  ]
}
Resource

Status

The original read routes, kept as they were for existing integrations.

Status of every site

GET/status

scopereadplanPro and up

Every monitor in the state the Overview shows, with the last check and the open incident. ?ids=a,b narrows it (at most 200). The first route of the API, kept as it is; for filters and pages use /monitors.

Needs: any token (read scope), on the Pro plan or above.

Query parameters

  • idsstring

Returns

200The workspace and its sites.

Show the response fields
  • workspaceobjectrequired
    Show 2 child fields
    • idstringrequired
    • namestringrequired
  • generatedAtstring (ISO 8601)required
  • sitesarray of objectsrequired
    Show 11 child fields
    • idstringrequired
    • namestringrequired
    • urlstringrequired
    • kindstringrequired
    • enabledbooleanrequired
    • statestringrequired

      One ofupdownpausedunknownmaintenanceblocked

    • checkedAtstring (ISO 8601) · nullablerequired
    • latencyMsinteger · nullablerequired
    • statusCodeinteger · nullablerequired
    • errorstring · nullablerequired
    • incidentobject · nullablerequired
      Show 3 child fields
      • idstringrequired
      • startedAtstring (ISO 8601)required
      • errorstring · nullablerequired
400
Bad request. The original error shape: { "error": "text" }.
401
Unauthorized. The original error shape: { "error": "text" }.
403
Forbidden. The original error shape: { "error": "text" }.
429
Too many requests. The original error shape: { "error": "text" }.
GET/status
Response 200
{
  "workspace": {
    "id": "cmh3k2x9a0000qv08wksp0001",
    "name": "Acme"
  },
  "generatedAt": "2026-11-10T09:30:00.000Z",
  "sites": [
    {
      "id": "cmh3k2x9a0001qv08abcd1234",
      "name": "Shop",
      "url": "https://shop.example.com/",
      "kind": "web",
      "enabled": true,
      "state": "up",
      "checkedAt": "2026-11-10T09:29:12.000Z",
      "latencyMs": 182,
      "statusCode": 200,
      "error": null,
      "incident": null
    }
  ]
}

One site with its history (deprecated)

GET/sites/{id}

DeprecatedscopereadplanPro and up

Uptime over 30 and 90 days, the last 30 days, the 24-hour response time, certificate and domain expiry, recent incidents, PageSpeed and links. Kept for existing integrations; use /monitors/{id} and /monitors/{id}/metrics.

Needs: any token (read scope), on the Pro plan or above.

Path parameters

  • idstringrequired
    The record id.

Returns

200The site.

Show the response fields
  • generatedAtstring (ISO 8601)required
  • siteobjectrequired
    Show 11 child fields
    • idstringrequired
    • namestringrequired
    • urlstringrequired
    • kindstringrequired
    • enabledbooleanrequired
    • statestringrequired

      One ofupdownpausedunknownmaintenanceblocked

    • checkedAtstring (ISO 8601) · nullablerequired
    • latencyMsinteger · nullablerequired
    • statusCodeinteger · nullablerequired
    • errorstring · nullablerequired
    • incidentobject · nullablerequired
      Show 3 child fields
      • idstringrequired
      • startedAtstring (ISO 8601)required
      • errorstring · nullablerequired
  • uptimeobjectrequired
    Show 2 child fields
    • days30number · nullablerequired
    • days90number · nullablerequired
  • daysarray of objectsrequired
    Show 4 child fields
    • datestringrequired
    • monitoredbooleanrequired
    • downtimeMinutesintegerrequired
    • incidentsintegerrequired
  • latency24hobjectrequired
    Show 2 child fields
    • hourlyarray of numbersrequired
    • avgMsnumber · nullablerequired
  • sslobject · nullablerequired
    Show 2 child fields
    • validboolean · nullablerequired
    • expiresAtstring (ISO 8601) · nullablerequired
  • domainExpiresAtstring (ISO 8601) · nullablerequired
  • incidentsarray of objectsrequired
    Show 4 child fields
    • idstringrequired
    • startedAtstring (ISO 8601)required
    • endedAtstring (ISO 8601) · nullablerequired
    • errorstring · nullablerequired
  • pagespeedobject · nullablerequired
    The latest PageSpeed runs: phone at the top level, desktop under desktop; null without runs.
    Show 12 child fields
    • checkedAtstring (ISO 8601)required
    • errorstring · nullablerequired
    • urlstringrequired
    • latestobject · nullablerequired
      Show 9 child fields
      • atstring (ISO 8601)required
      • scorenumber · nullablerequired
      • accessibilitynumber · nullablerequired
      • bestPracticesnumber · nullablerequired
      • seonumber · nullablerequired
      • lcpMsnumber · nullablerequired
      • clsnumber · nullablerequired
      • inpMsnumber · nullablerequired
      • sourcestringrequired

        One offieldlab

    • historyarray of objectsrequired
      Show 2 child fields
      • atstring (ISO 8601)required
      • scorenumber · nullablerequired
    • fieldobject · nullablerequired
      Show 4 child fields
      • overallstring · nullablerequired

        One offastaverageslow

      • lcpobject · nullablerequired
        Show 2 child fields
        • p75numberrequired
        • goodnumberrequired
      • inpobject · nullablerequired
        Show 2 child fields
        • p75numberrequired
        • goodnumberrequired
      • clsobject · nullablerequired
        Show 2 child fields
        • p75numberrequired
        • goodnumberrequired
    • labobject · nullablerequired
      Show 5 child fields
      • fcpMsnumber · nullablerequired
      • lcpMsnumber · nullablerequired
      • tbtMsnumber · nullablerequired
      • clsnumber · nullablerequired
      • speedIndexMsnumber · nullablerequired
    • auditsarray of objectsrequired
      Show 3 child fields
      • titlestringrequired
      • displaystring · nullablerequired
      • savingsMsnumber · nullablerequired
    • issuesobjectrequired
      Show 3 child fields
      • accessibilityintegerrequired
      • bestPracticesintegerrequired
      • seointegerrequired
    • reportUrlstring · nullablerequired
      The full Lighthouse report of the run in latest (the official HTML report, nothing is run again), as a signed link anyone can open without an account. Add ?download=1 to save it, ?format=json for the JSON. It works for 30 days after the run unless the site is deleted; take it from here when a person opens the site rather than storing it. Null when that run has no stored report.
    • reportedAtstring (ISO 8601) · nullablerequired
      When the run behind reportUrl was made.
    • desktopobject · nullablerequired
      Show 8 child fields
      • latestobjectrequired
        Show 9 child fields
        • atstring (ISO 8601)required
        • scorenumber · nullablerequired
        • accessibilitynumber · nullablerequired
        • bestPracticesnumber · nullablerequired
        • seonumber · nullablerequired
        • lcpMsnumber · nullablerequired
        • clsnumber · nullablerequired
        • inpMsnumber · nullablerequired
        • sourcestringrequired

          One offieldlab

      • historyarray of objectsrequired
        Show 2 child fields
        • atstring (ISO 8601)required
        • scorenumber · nullablerequired
      • fieldobject · nullablerequired
        Show 4 child fields
        • overallstring · nullablerequired

          One offastaverageslow

        • lcpobject · nullablerequired
          Show 2 child fields
          • p75numberrequired
          • goodnumberrequired
        • inpobject · nullablerequired
          Show 2 child fields
          • p75numberrequired
          • goodnumberrequired
        • clsobject · nullablerequired
          Show 2 child fields
          • p75numberrequired
          • goodnumberrequired
      • labobject · nullablerequired
        Show 5 child fields
        • fcpMsnumber · nullablerequired
        • lcpMsnumber · nullablerequired
        • tbtMsnumber · nullablerequired
        • clsnumber · nullablerequired
        • speedIndexMsnumber · nullablerequired
      • auditsarray of objectsrequired
        Show 3 child fields
        • titlestringrequired
        • displaystring · nullablerequired
        • savingsMsnumber · nullablerequired
      • issuesobjectrequired
        Show 3 child fields
        • accessibilityintegerrequired
        • bestPracticesintegerrequired
        • seointegerrequired
      • reportUrlstring · nullablerequired
        The full Lighthouse report of the run in latest (the official HTML report, nothing is run again), as a signed link anyone can open without an account. Add ?download=1 to save it, ?format=json for the JSON. It works for 30 days after the run unless the site is deleted; take it from here when a person opens the site rather than storing it. Null when that run has no stored report.
      • reportedAtstring (ISO 8601) · nullablerequired
        When the run behind reportUrl was made.
  • performanceanyrequired
    The usual and recent response time, and the open slowdown warning.
  • linksobjectrequired
    Show 2 child fields
    • monitorstringrequired
    • statusPageobject · nullablerequired
      Show 3 child fields
      • namestringrequired
      • urlstringrequired
      • privatebooleanrequired
401
Unauthorized. The original error shape: { "error": "text" }.
403
Forbidden. The original error shape: { "error": "text" }.
404
Not found. The original error shape: { "error": "text" }.
429
Too many requests. The original error shape: { "error": "text" }.
GET/sites/{id}
Response 200
{
  "generatedAt": "2026-11-10T09:30:00Z",
  "site": {
    "id": "string",
    "name": "string",
    "url": "string",
    "kind": "string",
    "enabled": true,
    "state": "up",
    "checkedAt": "2026-11-10T09:30:00Z",
    "latencyMs": 0,
    "statusCode": 0,
    "error": "string",
    "incident": {
      "id": "string",
      "startedAt": "2026-11-10T09:30:00Z",
      "error": "string"
    }
  },
  "uptime": {
    "days30": 0,
    "days90": 0
  },
  "days": [
    {
      "date": "string",
      "monitored": true,
      "downtimeMinutes": 0,
      "incidents": 0
    }
  ],
  "latency24h": {
    "hourly": [
      0
    ],
    "avgMs": 0
  },
  "ssl": {
    "valid": true,
    "expiresAt": "2026-11-10T09:30:00Z"
  },
  "domainExpiresAt": "2026-11-10T09:30:00Z",
  "incidents": [
    {
      "id": "string",
      "startedAt": "2026-11-10T09:30:00Z",
      "endedAt": "2026-11-10T09:30:00Z",
      "error": "string"
    }
  ],
  "pagespeed": {
    "checkedAt": "2026-11-10T09:30:00Z",
    "error": "string",
    "url": "string",
    "latest": {
      "at": "2026-11-10T09:30:00Z",
      "score": 0,
      "accessibility": 0,
      "bestPractices": 0,
      "seo": 0,
      "lcpMs": 0,
      "cls": 0,
      "inpMs": 0,
      "source": "field"
    },
    "history": [
      {
        "at": "2026-11-10T09:30:00Z",
        "score": 0
      }
    ],
    "field": {
      "overall": "fast",
      "lcp": {
        "p75": 0,
        "good": 0
      },
      "inp": {
        "p75": 0,
        "good": 0
      },
      "cls": {
        "p75": 0,
        "good": 0
      }
    },
    "lab": {
      "fcpMs": 0,
      "lcpMs": 0,
      "tbtMs": 0,
      "cls": 0,
      "speedIndexMs": 0
    },
    "audits": [
      {
        "title": "string",
        "display": "string",
        "savingsMs": 0
      }
    ],
    "issues": {
      "accessibility": 0,
      "bestPractices": 0,
      "seo": 0
    },
    "reportUrl": "string",
    "reportedAt": "2026-11-10T09:30:00Z",
    "desktop": {
      "latest": {
        "at": "2026-11-10T09:30:00Z",
        "score": 0,
        "accessibility": 0,
        "bestPractices": 0,
        "seo": 0,
        "lcpMs": 0,
        "cls": 0,
        "inpMs": 0,
        "source": "field"
      },
      "history": [
        {
          "at": "2026-11-10T09:30:00Z",
          "score": 0
        }
      ],
      "field": {
        "overall": "fast",
        "lcp": {
          "p75": 0,
          "good": 0
        },
        "inp": {
          "p75": 0,
          "good": 0
        },
        "cls": {
          "p75": 0,
          "good": 0
        }
      },
      "lab": {
        "fcpMs": 0,
        "lcpMs": 0,
        "tbtMs": 0,
        "cls": 0,
        "speedIndexMs": 0
      },
      "audits": [
        {
          "title": "string",
          "display": "string",
          "savingsMs": 0
        }
      ],
      "issues": {
        "accessibility": 0,
        "bestPractices": 0,
        "seo": 0
      },
      "reportUrl": "string",
      "reportedAt": "2026-11-10T09:30:00Z"
    }
  },
  "links": {
    "monitor": "string",
    "statusPage": {
      "name": "string",
      "url": "string",
      "private": true
    }
  }
}

Get this OpenAPI document

GET/openapi.json

scopepublicplanStarter and upNo token needed

The OpenAPI 3.1 document of this API, built from the same schemas the API validates with. Public: no token needed.

Returns

200The document.

GET/openapi.json
Response 200
{}