Skip to content
StatusTick

API reference

Heartbeats

Heartbeats endpoints of the StatusTick REST API: change a heartbeat's grace period, schedule or finish within, check a cron expression and list the next runs.

PATCH/v1/monitors/{monitorId}/heartbeat

Needs a READ_WRITE key. Only for HEARTBEAT monitors.

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

monitorId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PATCH "https://example.com/v1/monitors/mnt_4KrVK3M1DqhDTFouCffKie/heartbeat" \
  -H "Content-Type: application/json" \
  -d '{
    "graceSeconds": 600,
    "cron": "0 3 * * *",
    "timeZone": "Europe/Berlin"
  }'
{
  "id": "string",
  "name": "string",
  "slug": "string",
  "url": "string",
  "type": "HTTP",
  "intervalSeconds": 0,
  "settings": {
    "notificationDelayMinutes": 0,
    "timeoutSeconds": 0,
    "sslCheckEnabled": true,
    "redirectCheckEnabled": true,
    "httpMethod": "GET",
    "requestHeaders": {
      "property1": "string",
      "property2": "string"
    },
    "requestBody": "string",
    "requestBodyType": "RAW",
    "expectedStatusCodes": [
      0
    ],
    "expectedResponseHeaders": {
      "property1": "string",
      "property2": "string"
    },
    "responseTextCheck": "string",
    "responseTextMode": "CONTAINS",
    "responseTextCaseSensitive": true,
    "jsonAssertions": [
      {
        "path": "string",
        "equals": "string",
        "exists": true
      }
    ],
    "zones": [
      "GLOBAL"
    ],
    "locationIds": [
      "string"
    ],
    "requiredFailingZones": 0,
    "blockedOpensIncident": true,
    "degradedResponseTimeMs": 0,
    "ipVersion": "AUTO",
    "sslExpiryAlertDays": [
      0
    ],
    "sslOnTCP": true,
    "domainExpiryCheckEnabled": true,
    "domainExpiryAlertDays": [
      0
    ],
    "assetCheckEnabled": true,
    "assetIgnoreHosts": [
      "string"
    ],
    "dnsRecordType": "string"
  },
  "locationIds": [
    "string"
  ],
  "nextCheckAt": "2019-08-24T14:15:22Z",
  "lastCheckAt": "2019-08-24T14:15:22Z",
  "lastCheckStatus": "UP",
  "lastResponseTimeMs": 0,
  "certificate": {
    "validFrom": "string",
    "validTo": "string",
    "issuer": "string",
    "subject": "string",
    "valid": true,
    "error": "string",
    "checkedAt": "string",
    "legacyTLS": true,
    "tlsVersion": "string",
    "weakKey": true
  },
  "heartbeat": {
    "pingPath": "string",
    "pingURL": "string",
    "graceSeconds": 0,
    "graceText": "string",
    "lastPingAt": "string",
    "lastDurationMs": 0,
    "lastDurationText": "string",
    "cron": "string",
    "timeZone": "string",
    "finishWithinSeconds": 0,
    "usualRunTimeMs": 0,
    "runningLongAfterMs": 0,
    "usualRunTimeRuns": 0,
    "usualRunTimeText": "string",
    "scheduleText": "string",
    "rotatingUntil": "string",
    "urlLastUsedAt": "string",
    "previousURLLastUsedAt": "string",
    "runningLong": {
      "runId": "string",
      "startedAt": "string",
      "usualText": "string",
      "finishByText": "string"
    }
  },
  "domain": {
    "name": "string",
    "expiresAt": "string",
    "registrar": "string",
    "checkedAt": "string"
  },
  "pageAssets": {},
  "browser": {
    "script": "string",
    "language": "TYPESCRIPT",
    "variables": {
      "property1": "string",
      "property2": "string"
    },
    "allowedHosts": [
      "string"
    ],
    "slowStepThresholdsMs": {
      "property1": 1,
      "property2": 1
    }
  },
  "database": {
    "database": "string",
    "user": "string",
    "password": "string",
    "userEnv": "string",
    "passwordEnv": "string",
    "tls": false,
    "tlsVerify": true,
    "query": "string",
    "expectedValue": "string"
  },
  "mcp": {
    "authHeaderName": "string",
    "authHeaderValue": "string",
    "toolCount": 0,
    "toolsHash": "string",
    "schemaChangedAt": "2019-08-24T14:15:22Z",
    "serverName": "string",
    "serverVersion": "string",
    "protocolVersion": "string"
  },
  "protocol": {
    "grpcService": "string",
    "tlsMode": "NONE",
    "tlsVerify": true,
    "requireStartTLS": false
  },
  "vendorIds": [
    "string"
  ],
  "inMaintenance": true,
  "locationOffline": true,
  "tags": [
    "string"
  ],
  "group": "string",
  "managedBy": "KUBERNETES",
  "managedKey": "string",
  "status": "ACTIVE",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
GET/v1/monitors/{monitorId}/heartbeat/schedule

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

monitorId*string

Query Parameters

cron?string

Default is the monitor's own schedule.

timeZone?string
count?integer
Default3
graceSeconds?integer

Default is the monitor's own.

finishWithinSeconds?integer

Default is the monitor's own; 0 is off.

intervalSeconds?integer

Interval mode (an empty cron): default is the monitor's own.

Response Body

application/json

curl -X GET "https://example.com/v1/monitors/mnt_4KrVK3M1DqhDTFouCffKie/heartbeat/schedule?cron=0+3+*+*+*&timeZone=Europe%2FBerlin"
{
  "cron": "0 3 * * *",
  "timeZone": "Europe/Berlin",
  "valid": true,
  "error": null,
  "nextRuns": [
    "2026-09-29T01:00:00Z",
    "2026-09-30T01:00:00Z",
    "2026-10-01T01:00:00Z"
  ]
}
GET/v1/monitors/heartbeat/schedule

The same answer as the preview of an existing monitor; a value left out is the default of a new monitor.

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Query Parameters

cron?string

Empty or left out for interval mode.

timeZone?string
Default"UTC"
count?integer
Default3
graceSeconds?integer
Default300
finishWithinSeconds?integer

0 or left out: off.

intervalSeconds?integer

Interval mode only.

Default3600

Response Body

application/json

curl -X GET "https://example.com/v1/monitors/heartbeat/schedule?cron=0+3+*+*+*&timeZone=Europe%2FBerlin"
{
  "cron": "0 3 * * *",
  "timeZone": "Europe/Berlin",
  "valid": true,
  "error": null,
  "nextRuns": [
    "2026-09-29T01:00:00Z",
    "2026-09-30T01:00:00Z",
    "2026-10-01T01:00:00Z"
  ],
  "description": "At 03:00 every day",
  "nextRunsText": "Tue 03:00, Wed 03:00, Thu 03:00 (Europe/Berlin).",
  "deadlinesText": "Late after 03:05. No finish deadline."
}
GET/v1/monitors/{monitorId}/runs

Every run of the job, newest first: from its /start ping (if sent) to its success or /fail ping. Add ?run=<id> (1 to 64 letters, digits, - or _) to the ping URLs to tie a start to its finish. Runs are kept as long as check results.

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

monitorId*string

Query Parameters

limit?integer
Rangevalue <= 100
Default20
after?string

The previous page's nextCursor.

problem?string

Only runs with this problem; any: with any problem. MISSED records count as missed.

Value in

  • "any"
  • "missed"
  • "late"
  • "off_schedule"
  • "double_fire"
  • "overlap"
  • "running_long"
  • "not_finished_on_time"
  • "lost"
  • "failed"
through?string

A run's id: the page reaches down to that run (up to 500 runs), for a link to one run.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/monitors/mnt_4KrVK3M1DqhDTFouCffKie/runs"
{
  "items": [
    {
      "id": "jrn_5Fq2Lw8ZkTn3VbR6Hc1PaD",
      "monitorId": "mnt_4KrVK3M1DqhDTFouCffKie",
      "runId": "nightly-2026-10-07",
      "scheduledAt": "2026-10-07T01:00:00Z",
      "startedAt": "2026-10-07T01:00:04Z",
      "finishedAt": "2026-10-07T01:03:10Z",
      "durationMs": 186000,
      "outcome": "SUCCEEDED",
      "marks": [],
      "pairedByOrder": false
    }
  ],
  "nextCursor": null
}
GET/v1/monitors/{monitorId}/runs/counts

How many runs and missed times are kept, how many of them have any problem, and how many have each problem. A problem no run has is left out. Both runs of a double fire count as double_fire.

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

monitorId*string

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/monitors/mnt_4KrVK3M1DqhDTFouCffKie/runs/counts"
{
  "all": 90,
  "withProblem": 7,
  "problems": [
    {
      "problem": "missed",
      "count": 1
    },
    {
      "problem": "double_fire",
      "count": 2
    },
    {
      "problem": "failed",
      "count": 1
    }
  ]
}

Make a new ping URL

POST/v1/monitors/{monitorId}/heartbeat/token

Needs a READ_WRITE key. The old ping URL keeps working for 60 minutes (heartbeat.rotatingUntil), so you can update the job first; a ping on either URL counts. Making another one during that time stops the older URL at once.

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

monitorId*string

Response Body

application/json

curl -X POST "https://example.com/v1/monitors/mnt_4KrVK3M1DqhDTFouCffKie/heartbeat/token"
{
  "id": "string",
  "name": "string",
  "slug": "string",
  "url": "string",
  "type": "HTTP",
  "intervalSeconds": 0,
  "settings": {
    "notificationDelayMinutes": 0,
    "timeoutSeconds": 0,
    "sslCheckEnabled": true,
    "redirectCheckEnabled": true,
    "httpMethod": "GET",
    "requestHeaders": {
      "property1": "string",
      "property2": "string"
    },
    "requestBody": "string",
    "requestBodyType": "RAW",
    "expectedStatusCodes": [
      0
    ],
    "expectedResponseHeaders": {
      "property1": "string",
      "property2": "string"
    },
    "responseTextCheck": "string",
    "responseTextMode": "CONTAINS",
    "responseTextCaseSensitive": true,
    "jsonAssertions": [
      {
        "path": "string",
        "equals": "string",
        "exists": true
      }
    ],
    "zones": [
      "GLOBAL"
    ],
    "locationIds": [
      "string"
    ],
    "requiredFailingZones": 0,
    "blockedOpensIncident": true,
    "degradedResponseTimeMs": 0,
    "ipVersion": "AUTO",
    "sslExpiryAlertDays": [
      0
    ],
    "sslOnTCP": true,
    "domainExpiryCheckEnabled": true,
    "domainExpiryAlertDays": [
      0
    ],
    "assetCheckEnabled": true,
    "assetIgnoreHosts": [
      "string"
    ],
    "dnsRecordType": "string"
  },
  "locationIds": [
    "string"
  ],
  "nextCheckAt": "2019-08-24T14:15:22Z",
  "lastCheckAt": "2019-08-24T14:15:22Z",
  "lastCheckStatus": "UP",
  "lastResponseTimeMs": 0,
  "certificate": {
    "validFrom": "string",
    "validTo": "string",
    "issuer": "string",
    "subject": "string",
    "valid": true,
    "error": "string",
    "checkedAt": "string",
    "legacyTLS": true,
    "tlsVersion": "string",
    "weakKey": true
  },
  "heartbeat": {
    "pingPath": "string",
    "pingURL": "string",
    "graceSeconds": 0,
    "graceText": "string",
    "lastPingAt": "string",
    "lastDurationMs": 0,
    "lastDurationText": "string",
    "cron": "string",
    "timeZone": "string",
    "finishWithinSeconds": 0,
    "usualRunTimeMs": 0,
    "runningLongAfterMs": 0,
    "usualRunTimeRuns": 0,
    "usualRunTimeText": "string",
    "scheduleText": "string",
    "rotatingUntil": "string",
    "urlLastUsedAt": "string",
    "previousURLLastUsedAt": "string",
    "runningLong": {
      "runId": "string",
      "startedAt": "string",
      "usualText": "string",
      "finishByText": "string"
    }
  },
  "domain": {
    "name": "string",
    "expiresAt": "string",
    "registrar": "string",
    "checkedAt": "string"
  },
  "pageAssets": {},
  "browser": {
    "script": "string",
    "language": "TYPESCRIPT",
    "variables": {
      "property1": "string",
      "property2": "string"
    },
    "allowedHosts": [
      "string"
    ],
    "slowStepThresholdsMs": {
      "property1": 1,
      "property2": 1
    }
  },
  "database": {
    "database": "string",
    "user": "string",
    "password": "string",
    "userEnv": "string",
    "passwordEnv": "string",
    "tls": false,
    "tlsVerify": true,
    "query": "string",
    "expectedValue": "string"
  },
  "mcp": {
    "authHeaderName": "string",
    "authHeaderValue": "string",
    "toolCount": 0,
    "toolsHash": "string",
    "schemaChangedAt": "2019-08-24T14:15:22Z",
    "serverName": "string",
    "serverVersion": "string",
    "protocolVersion": "string"
  },
  "protocol": {
    "grpcService": "string",
    "tlsMode": "NONE",
    "tlsVerify": true,
    "requireStartTLS": false
  },
  "vendorIds": [
    "string"
  ],
  "inMaintenance": true,
  "locationOffline": true,
  "tags": [
    "string"
  ],
  "group": "string",
  "managedBy": "KUBERNETES",
  "managedKey": "string",
  "status": "ACTIVE",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
POST/v1/monitors/{monitorId}/heartbeat/token/end-overlap

Needs a READ_WRITE key. After a new ping URL was made, the old one stops working at once instead of after 60 minutes.

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

monitorId*string

Response Body

application/json

curl -X POST "https://example.com/v1/monitors/mnt_4KrVK3M1DqhDTFouCffKie/heartbeat/token/end-overlap"
{
  "id": "string",
  "name": "string",
  "slug": "string",
  "url": "string",
  "type": "HTTP",
  "intervalSeconds": 0,
  "settings": {
    "notificationDelayMinutes": 0,
    "timeoutSeconds": 0,
    "sslCheckEnabled": true,
    "redirectCheckEnabled": true,
    "httpMethod": "GET",
    "requestHeaders": {
      "property1": "string",
      "property2": "string"
    },
    "requestBody": "string",
    "requestBodyType": "RAW",
    "expectedStatusCodes": [
      0
    ],
    "expectedResponseHeaders": {
      "property1": "string",
      "property2": "string"
    },
    "responseTextCheck": "string",
    "responseTextMode": "CONTAINS",
    "responseTextCaseSensitive": true,
    "jsonAssertions": [
      {
        "path": "string",
        "equals": "string",
        "exists": true
      }
    ],
    "zones": [
      "GLOBAL"
    ],
    "locationIds": [
      "string"
    ],
    "requiredFailingZones": 0,
    "blockedOpensIncident": true,
    "degradedResponseTimeMs": 0,
    "ipVersion": "AUTO",
    "sslExpiryAlertDays": [
      0
    ],
    "sslOnTCP": true,
    "domainExpiryCheckEnabled": true,
    "domainExpiryAlertDays": [
      0
    ],
    "assetCheckEnabled": true,
    "assetIgnoreHosts": [
      "string"
    ],
    "dnsRecordType": "string"
  },
  "locationIds": [
    "string"
  ],
  "nextCheckAt": "2019-08-24T14:15:22Z",
  "lastCheckAt": "2019-08-24T14:15:22Z",
  "lastCheckStatus": "UP",
  "lastResponseTimeMs": 0,
  "certificate": {
    "validFrom": "string",
    "validTo": "string",
    "issuer": "string",
    "subject": "string",
    "valid": true,
    "error": "string",
    "checkedAt": "string",
    "legacyTLS": true,
    "tlsVersion": "string",
    "weakKey": true
  },
  "heartbeat": {
    "pingPath": "string",
    "pingURL": "string",
    "graceSeconds": 0,
    "graceText": "string",
    "lastPingAt": "string",
    "lastDurationMs": 0,
    "lastDurationText": "string",
    "cron": "string",
    "timeZone": "string",
    "finishWithinSeconds": 0,
    "usualRunTimeMs": 0,
    "runningLongAfterMs": 0,
    "usualRunTimeRuns": 0,
    "usualRunTimeText": "string",
    "scheduleText": "string",
    "rotatingUntil": "string",
    "urlLastUsedAt": "string",
    "previousURLLastUsedAt": "string",
    "runningLong": {
      "runId": "string",
      "startedAt": "string",
      "usualText": "string",
      "finishByText": "string"
    }
  },
  "domain": {
    "name": "string",
    "expiresAt": "string",
    "registrar": "string",
    "checkedAt": "string"
  },
  "pageAssets": {},
  "browser": {
    "script": "string",
    "language": "TYPESCRIPT",
    "variables": {
      "property1": "string",
      "property2": "string"
    },
    "allowedHosts": [
      "string"
    ],
    "slowStepThresholdsMs": {
      "property1": 1,
      "property2": 1
    }
  },
  "database": {
    "database": "string",
    "user": "string",
    "password": "string",
    "userEnv": "string",
    "passwordEnv": "string",
    "tls": false,
    "tlsVerify": true,
    "query": "string",
    "expectedValue": "string"
  },
  "mcp": {
    "authHeaderName": "string",
    "authHeaderValue": "string",
    "toolCount": 0,
    "toolsHash": "string",
    "schemaChangedAt": "2019-08-24T14:15:22Z",
    "serverName": "string",
    "serverVersion": "string",
    "protocolVersion": "string"
  },
  "protocol": {
    "grpcService": "string",
    "tlsMode": "NONE",
    "tlsVerify": true,
    "requireStartTLS": false
  },
  "vendorIds": [
    "string"
  ],
  "inMaintenance": true,
  "locationOffline": true,
  "tags": [
    "string"
  ],
  "group": "string",
  "managedBy": "KUBERNETES",
  "managedKey": "string",
  "status": "ACTIVE",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
All docs