Skip to main content
POST
Health Checks
Manage and run HTTP health checks. Dispatch the desired operation with the action field in the request body.

Actions

Request body

string
required
One of list, add, delete, run, or schedule.
object
Payload for the selected action. Required for every action except list.

Response

The response shape varies by action.
boolean
required
Always true on success. Errors return false with an error string.
array
Returned by list. Each route includes id, url, name, createdAt, and its latest HealthResult (or null).
object
Returned by add. The newly created route (id, url, name, createdAt).
object
Returned by run. A HealthResult with status (up, slow, down, error), statusCode, responseMs, and checkedAt.
string
Returned by schedule. Identifier of the scheduled job.
Every successful response includes the X-Credits-Remaining header with your remaining credit balance.