Update check properties

Bulk update metadata and state of one or more data quality checks. Accepts an array of check updates, each identified by metric_unique_identifier. Supports updating state (enabled/disabled), description, category, and sample configuration. To modify check definitions (operator, threshold, configuration), use the monitor update endpoint (PUT /monitor). Only fields included in the request are updated; omitted fields remain unchanged.

Body Params

Request to update metadata and state of a single check. Only specified fields are updated; omitted fields remain unchanged. At least one field besides metric_unique_identifier must be provided. Check definition fields (operator, threshold, configuration_keys) are not updatable through this endpoint — use PUT /monitor to modify check definitions.

uuid
required

The unique identifier of the check to update.

boolean

Set to true to enable the check, false to pause it. Paused checks are skipped during monitor runs but retained in the system.

string
length ≤ 1000

Updated human-readable description of what this check validates.

string | null

Updated SQL query to retrieve sample records that fail this check. Set to null to clear.

integer | null
≥ 1

Updated maximum number of failed sample records to collect.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json