Skip to main content
POST
Batch update rule fields

Restrictions

Usage

  • Each listed field takes the value of the same-named request field; a listed field whose value is omitted is set to its zero value (for example, listing labels without labels or labels_patch removes all labels). Unlisted fields keep their current values.
  • An unknown name in fields, a labels_patch / annotations_patch whose field is not listed in fields, or sending labels together with labels_patch (or annotations with annotations_patch) fails the whole call with InvalidParameter.
  • Rules are updated one by one and the result has one entry per ID: message is empty on success, otherwise it carries that rule’s error (validation failure, no access to its folder, or an unknown ID, whose name is then id: <id>).
  • Setting enabled to false clears the rules’ active alerts. Unless the call only disables rules (fields is exactly ["enabled"] with enabled: false), it fails with AccessDenied when the account exceeds its alert rule license limit, and non-admin callers need read-only access to every datasource each rule selects.
  • Every call is recorded in the account audit log. Don’t put secrets in request fields.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json
ids
integer<uint64>[]
required

IDs of the rules to update; must contain 1 to 100 IDs.

Required array length: 1 - 100 elements
fields
enum<string>[]
required

Names of the fields to update. Each listed field takes the value of the same-named request field, and is set to its zero value when that value is omitted; values sent for unlisted fields are ignored. An unknown name fails the whole call with InvalidParameter.

Available options:
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
labels
object

Custom label key-value pairs; replaces existing labels as a whole. Effective only when fields includes labels; cannot be sent together with labels_patch.

ds_type
string

Datasource type identifier. Enabled rules must use a type that supports alerting: prometheus, elasticsearch, loki, clickhouse, mysql, oracle, postgres, sls, tencent_cls, victorialogs. Effective only when fields includes ds_type.

ds_list
string[]

Datasource name match patterns; wildcards supported. Effective only when fields includes ds_list.

ds_ids
integer<uint64>[]

Datasource IDs, merged with ds_list to decide which datasources the rule monitors; IDs survive datasource renames. Effective only when fields includes ds_ids.

enabled
boolean

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.

debug_log_enabled
boolean

Whether to enable debug logging; the edge emits detailed evaluation logs for troubleshooting. Effective only when fields includes debug_log_enabled.

cron_pattern
string

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
string
default:Asia/Shanghai

Timezone the rule runs in, as an IANA name (e.g. Asia/Shanghai, UTC); empty falls back to Asia/Shanghai. Effective only when fields includes timezone.

delay_seconds
integer

Seconds to shift the evaluation query window backward, compensating for data ingestion latency. Effective only when fields includes delay_seconds.

enabled_times
object[]

Time windows during which the rule is in effect; element structure see EnabledTime. Effective only when fields includes enabled_times.

annotations
object

Annotation key-value pairs delivered with alert events; replaces existing annotations as a whole, and keys must not start with $ (reserved for query fields). Effective only when fields includes annotations; cannot be sent together with annotations_patch.

description
string

Rule description, rendered according to the rule's existing description_type (which this endpoint cannot change). Effective only when fields includes description.

channel_ids
integer<uint64>[]

IDs of the collaboration spaces alerts are sent to; may be empty. Effective only when fields includes channel_ids.

repeat_interval
integer<int64>

Interval in seconds between repeated alert notifications; values below 1 fall back to 3600, maximum 2147483647. Effective only when fields includes repeat_interval.

repeat_total
integer<int64>

Maximum number of repeated notifications; values below 1 fall back to 3, maximum 2147483647. Effective only when fields includes repeat_total.

labels_patch
object

Partial label update that keeps unmentioned labels. Requires labels in fields and cannot be sent together with labels; otherwise the call returns InvalidParameter.

annotations_patch
object

Partial annotation update that keeps unmentioned annotations. Requires annotations in fields and cannot be sent together with annotations; otherwise the call returns InvalidParameter.

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.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object[]

Per-rule batch-operation results.