Batch update rule fields
Update specific fields across multiple alert rules at once. Only the fields listed in fields are applied.
Restrictions
Usage
- Include the field names you want to update in the
fieldsarray, e.g.["enabled", "channel_ids"]. - Only the specified fields are updated; others are left unchanged.
- Every call is recorded in the account audit log. Don’t put secrets in request fields.
Authorizations
App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.
Body
Rule IDs to update.
Field names to update. Only listed fields are updated, taking new values from the same-named request fields; values for unlisted fields are silently ignored.
labels, ds_type, ds_list, ds_ids, enabled, debug_log_enabled, cron_pattern, timezone, delay_seconds, enabled_times, annotations, description, channel_ids, repeat_interval, repeat_total Custom label key-value pairs; replaces existing labels as a whole. Effective only when fields includes labels.
Datasource type identifier; allowed values are listed by POST /monit/rule/dstypes. Effective only when fields includes ds_type.
Datasource name match patterns; wildcards supported. Effective only when fields includes ds_list.
Datasource IDs, merged with ds_list to decide which datasources the rule monitors; IDs survive datasource renames. Effective only when fields includes ds_ids.
Whether the rule is enabled. Setting it to false makes the server clean up the rule's active alerts. Effective only when fields includes enabled.
Whether to enable debug logging; the edge emits detailed evaluation logs for troubleshooting. Effective only when fields includes debug_log_enabled.
Schedule expression: a 6-field cron (with seconds) or an @every 30s interval descriptor; CRON_TZ=/TZ= prefixes are not allowed. Effective only when fields includes cron_pattern.
Timezone in which the rule executes. IANA timezone name; defaults to Asia/Shanghai.
Seconds to shift the evaluation query window backward, compensating for data ingestion latency. Effective only when fields includes delay_seconds.
Time windows during which the rule is in effect; element structure see EnabledTime. Effective only when fields includes enabled_times.
Annotation key-value pairs delivered with alert events; keys must not start with $ (reserved for query fields). Effective only when fields includes annotations.
Rule description (Markdown). Effective only when fields includes description.
IDs of the collaboration spaces alerts are sent to; may be empty. Effective only when fields includes channel_ids.
Interval in seconds between repeated alert notifications. Effective only when fields includes repeat_interval.
Maximum number of repeated notifications. Effective only when fields includes repeat_total.
Response
Success
Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.