Skip to content

Ingests an active probe result for a check and folds it into the subject's health.

POST
/v1/m/health/checks/{id}/report
curl --request POST \
--url https://example.com/v1/m/health/checks/example/report \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "detail": "example", "latency_ms": 1, "state": "healthy" }'

Ingests an active probe result for a check and folds it into the subject’s health.

id
required
string

Path parameter id.

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Media type application/json
object
detail
Any of:

Optional short probe detail; JSON null decodes as empty.

string
latency_ms
Any of:

Negative values are normalized to the unknown sentinel -1.

integer
state
required
string
Allowed values: healthy degraded down

OK

Media type application/json
object
Example generated
{}

Bad request

Media type application/json
object
Example generated
{}

Unauthenticated

Media type application/json
object
Example generated
{}

Forbidden

Media type application/json
object
Example generated
{}

Not found

Media type application/json
object
Example generated
{}

Conflict / setup required

Media type application/json
object
Example generated
{}

Rate limited

Media type application/json
object
Example generated
{}