Skip to content

API monitoring

Monitor a JSON or HTTP API: methods, headers, request bodies, status and JSON assertions, and stored secrets.

Core
  • Requires monitors:manage

Outcome

An API monitor sends a configured request and asserts on the status code, timing, headers, and JSON body.

Methods

API monitors support GET, HEAD, and POST. Set a request body for POST.

Headers and authentication

Add request headers, including an authorization header. Store the token as a secret so it is encrypted and masked.

Example request headers (placeholder token)
Authorization: Bearer YOUR_API_TOKEN
Accept: application/json

Assertions

AssertionUse
Status codeRequire an exact code or accepted set
Response timeFail or degrade past a threshold in milliseconds
Header equalsRequire a response header value
JSON pathCheck a value inside the JSON body

For JSON checks, see JSON path assertions.

Timeouts

A request that does not complete within the monitor's timeout is a failure. The default timeout is 10 seconds.

Example health endpoint

A minimal health response
{
  "status": "ok",
  "version": "2026.07",
  "checks": { "database": "ok" }
}

Was this page helpful?