alerts

Update an existing Alert Notification Silencing Rule

Updates an existing Alert Notification Silencing Rule according to the specifications provided

put/api/v2/spaces/{spaceID}/notifications/silencing/rule/ruleID

Request

Base URL
https://api.netdata.cloud (the document declares no server; this is the origin it was published from)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/netdata/apis/netdata-cloud-api/docs/api/v2/spaces/:spaceID/notifications/silencing/rule/ruleID/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

spaceIDstring uuid required

The unique identifier of the requested space.

ruleIDstring uuid required

The unique identifier of the Silencing Rule to be updated.

Request body

account_idstring uuid

The Account ID of the user that created the Silencing Rule

alert_contextsstring[]

The Alert Contexts to which the Silencing Rule is applicable

alert_instancesstring[]

The Alert Instances to which the Silencing Rule is applicable

alert_namesstring[]

The Alert names to which the Silencing Rule is applicable

alert_rolesstring[]

The Alert Roles to which the Silencing Rule is applicable. Each value is split on whitespace and commas into single roles, and the rule applies to an alert addressed to any of them

delete_on_expiryboolean

Opt-in: delete the Silencing Rule automatically once lasts_until passes. Requires lasts_until and cannot be combined with rrule; defaults to false when absent

disabledboolean

true if the Silencing Rule is Disabled

host_labelsobject

The host label key-values targeting the Nodes the Silencing Rule applies to

idstring uuid

The Silencing Rule ID

integration_idsstring[]

The Alert Notification Methods Integration IDs to which the Silencing Rule is applicable

lasts_untilstring

The end of the time window during which the Silencing Rule is applicable

namestring

The Silencing Rule friendly name

node_idsstring[]

The Node IDs to which the Silencing Rule is applicable

notification_optionsstring[]

The Notification Options to which the Silencing Rule is applicable

read_onlyboolean

true if the Silencing Rule is ReadOnly and cannot be edited

room_idsstring[]

The Room IDs to which the Silencing Rule is applicable

rrulestring

The RRule string defining the recurrence pattern of the Silencing Rule, if any. FREQ must be DAILY, WEEKLY, MONTHLY or YEARLY and may recur at most 24 times a day

starts_atstring

The beginning of the time window during which the Silencing Rule is applicable

state'INACTIVE' | 'ACTIVE' | 'SCHEDULED'

The current state of the Silencing Rule

timezonestring

The IANA timezone the Silencing Rule's recurrence is anchored to, if any. All times stay UTC on the wire; the timezone is applied only when computing recurrence, so it fires at the intended wall-clock time across DST transitions.

Example request

{
  "account_id": "0deede74-2257-48d7-8b3b-22e3728cd2ff",
  "alert_contexts": [
    "system.cpu",
    "cpu.cpu"
  ],
  "alert_instances": [
    "system.post_update_reboot_status"
  ],
  "alert_names": [
    "10min_cpu_iowait"
  ],
  "alert_roles": [
    "webmaster"
  ],
  "host_labels": {
    "{\"os\"": "\"linux\"}"
  },
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "integration_ids": [
    "303f0cc7-8613-4960-bea6-827be15cb043",
    "32000626-37df-4c20-9dd0-cbe2c834384e"
  ],
  "lasts_until": "2025-05-20T01:49:01.803Z",
  "name": "notify only for Criticals",
  "node_ids": [
    "21b52a82-8a5f-4a92-8446-8a84c7d1539c",
    "c6b6bcc9-27f1-47c0-ab47-c9cd2b6fc45a",
    "805e93d7-ad28-4003-a3cb-83e42d1765df"
  ],
  "notification_options": [
    "CRITICAL",
    "UNREACHABLE"
  ],
  "room_ids": [
    "7314a1f2-dcc9-44cb-b9af-297a362bd800",
    "fff17c3c-4a7c-4990-87c7-dcb7e5d70de8"
  ],
  "rrule": "RRULE:FREQ=DAILY",
  "starts_at": "2025-05-19T13:49:01.803Z",
  "state": "ACTIVE",
  "timezone": "Europe/Lisbon"
}

Response

The newly updated Silencing Rule