Partially update monitor properties

patch

https://{protocol}://{base-url}/integration/v1/native_data_quality/monitor

Bulk partial update of monitor-level properties for one or more monitors in a single request. Supports pausing/resuming (is_paused), updating title, description, priority, sample limit, notification channels, owners, approvers, and service account bindings. Check- and definition-level fields are not accepted here — use PATCH /check or PUT /monitor for those. Each item must include monitor_id and at least one updatable field; fields that are omitted are left unchanged. Notification channels, owners, approvers, and service_account_bindings all use replace-on-present semantics: omit the field to leave untouched, send an empty array to clear, or send a list to replace the set. Monitors in the request that do not exist are reported in the response's not_found list rather than failing the request.

Body Params

A single monitor's partial update for PATCH /monitor. monitor_id is required and at least one updatable field must be present. Omitted fields are left unchanged.

monitor_id

integer

required

The ID of the monitor to update.

is_paused

boolean

Pause (true) or resume (false) the monitor's scheduled execution.

monitor_title

string

length ≤ 255

monitor_description

string

length ≤ 1000

priority

string

enum

Business priority level. Case-insensitive; stored and returned in lowercase.

Allowed:

monitor_sample_limit

integer

Maximum number of failed sample records to collect per check, by default.

notification_channels

array of objects

Replaces the monitor's notification channels. Omit to leave unchanged, send an empty array to clear all channels, or send a list to replace the set.

notification_channels

owners

array of objects

Replaces the monitor's owners. Omit to leave unchanged, send an empty array to clear all owners, or send a list to replace the full set. Each entry requires id (positive integer) and otype (user or user_group).

owners

approvers

array of objects

Replaces the monitor's approvers. Omit to leave unchanged, send an empty array to clear all approvers, or send a list to replace the full set. Each entry requires approver_id (positive integer) and approver_type (user or group).

approvers

service_account_bindings

array of objects

Replaces the monitor's service account bindings. Omit to leave unchanged, send an empty array to clear all bindings, or send a list to replace the full set. Each entry requires ds_id and service_account_id (both positive integers). The service account must have the data_quality scope and the caller must have access to it.

service_account_bindings

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

200Bulk patch processed. Returns counts and any monitor IDs that were not found.

400Bad Request - Invalid input parameters

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

429Too Many Requests - Rate limit exceeded

500Internal Server Error