Skip to content

Declares a monitored subject.

POST
/v1/m/health/checks
curl --request POST \
--url https://example.com/v1/m/health/checks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "desired_status": "", "expected_interval_seconds": 1, "grace_factor": 1, "name": "example", "sla_target_ppm": 1, "subject_kind": "agent", "subject_ref": "example" }'

Declares a monitored subject. Creating a check is a privileged write, self-audited in the same transaction.

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
desired_status
Any of:

Empty keeps/defaults the lifecycle state; non-empty values are validated exactly.

string
Allowed values: "" active paused retired
expected_interval_seconds
Any of:

Values at or below zero select the server default.

integer
grace_factor
Any of:

Values at or below zero select the server default.

integer
name
Any of:

The handler stores this value after applying its byte cap.

string
sla_target_ppm
Any of:

Clamped by the handler to the inclusive range 0..1000000.

integer
subject_kind
required
string
Allowed values: agent mcp
subject_ref
required

Required exactly as decoded; the stored value is byte-capped.

string
>= 1 characters

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
{}