Patches a check's configuration.

PUT

/v1/m/health/checks/{id}

curl --request PUT \
  --url https://example.com/v1/m/health/checks/example \
  --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 }'

• this engine

Patches a check’s configuration. Privileged write, self-audited.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Path parameter id.

Header Parameters

X-Olivares-Tenant

string format: uuid

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

Request Body ^required

Media type application/json

object

desired_status

Any of:

string

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

string

Allowed values: "" active paused retired

null

null

expected_interval_seconds

Any of:

integer

Only positive values replace the stored interval.

integer

null

null

grace_factor

Any of:

integer

Only positive values replace the stored grace factor.

integer

null

null

name

Any of:

string

Empty keeps the stored name; non-empty values are byte-capped.

string

null

null

sla_target_ppm

Any of:

integer

A number is clamped to 0..1000000; omitted or null keeps the stored target.

integer

null

null

Responses

200

OK

Media type application/json

object

Example ^generated

{}

400

Bad request

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

409

Conflict / setup required

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}