Documentation
API monitor
Use API monitors to poll a public health endpoint for an exact HTTP status and response time.
Best for health endpoints
API monitors are outbound GET checks intended for public health, readiness, and status endpoints. They share the same checking engine as website monitors but are grouped separately in the monitor list and reports.
Request behavior
| Capability | Current behavior |
|---|---|
| Method | GET |
| Authentication | No custom headers or credentials |
| Success rule | Final response must exactly equal the configured HTTP status (200 by default) |
| Timeout | 1–5 seconds (3 seconds by default) |
| Redirects | Up to five, with every destination safety-checked |
| Response body | Not parsed, matched, or stored |
Failure threshold
- Each timeout, network error, unsafe redirect, redirect overflow, or unexpected status records a failed event.
- Before the configured number of consecutive failures is reached, the monitor is Late.
- At the threshold it becomes Fail and opens an incident; a passing check resets the count and resolves the incident.
- You can trigger an immediate check from the monitor detail page.
If your endpoint requires POST, an API key, a custom header, JSON-body validation, or a content assertion, that is not yet supported by outbound monitors. Expose a narrow public health endpoint or use a Script monitor that performs the request itself and reports the result.