Skip to main content
POST
cURL

Authorizations

Authorization
string
header
default:<your-api-key>
required

Caller API key issued by scripts/generate-api-key.ts. Sent as Authorization: Bearer . Verified against a stored SHA-256 hash in constant time by packages/api/src/auth/StaticKeyAuthenticator.ts. Required on every route not listed as exempt in this document's top-level description. See /api-reference/authentication.

Body

application/json
status
integer
required

The HTTP status the probe request received.

errorCode
string

The error code in the response body, when there is one.

Response

The probe result, as recorded.

The response is of type object.