--- title: "Update an existing Alert Notification Silencing Rule" method: PUT path: "/api/v2/spaces/{spaceID}/notifications/silencing/rule/ruleID" tags: ["alerts"] --- # Update an existing Alert Notification Silencing Rule `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) - URL: `https://api.netdata.cloud/api/v2/spaces/{spaceID}/notifications/silencing/rule/ruleID` - Auth: API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) Updates an existing Alert Notification Silencing Rule according to the specifications provided ## Path parameters - `spaceID` string, uuid, required - `ruleID` string, uuid, required ## Request body - ApiSilencingRule - `account_id` string, uuid: The Account ID of the user that created the Silencing Rule - `alert_contexts` string[]: The Alert Contexts to which the Silencing Rule is applicable - `alert_instances` string[]: The Alert Instances to which the Silencing Rule is applicable - `alert_names` string[]: The Alert names to which the Silencing Rule is applicable - `alert_roles` string[]: 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_expiry` boolean: 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 - `disabled` boolean: true if the Silencing Rule is Disabled - `host_labels` object: The host label key-values targeting the Nodes the Silencing Rule applies to - `id` string, uuid: The Silencing Rule ID - `integration_ids` string[]: The Alert Notification Methods Integration IDs to which the Silencing Rule is applicable - `lasts_until` string: The end of the time window during which the Silencing Rule is applicable - `name` string: The Silencing Rule friendly name - `node_ids` string[]: The Node IDs to which the Silencing Rule is applicable - `notification_options` string[]: The Notification Options to which the Silencing Rule is applicable - `read_only` boolean: true if the Silencing Rule is ReadOnly and cannot be edited - `room_ids` string[]: The Room IDs to which the Silencing Rule is applicable - `rrule` string: 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_at` string: The beginning of the time window during which the Silencing Rule is applicable - `state` 'INACTIVE' | 'ACTIVE' | 'SCHEDULED': The current state of the Silencing Rule - `timezone` string: 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. ## Response `200` The newly updated Silencing Rule - ApiSilencingRuleRes - `account_id` string, uuid: The Account ID of the user that created the Silencing Rule - `alert_contexts` string[]: The Alert Contexts to which the Silencing Rule is applicable - `alert_instances` string[]: The Alert Instances to which the Silencing Rule is applicable - `alert_names` string[]: The Alert names to which the Silencing Rule is applicable - `alert_roles` string[]: 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 - `created_at` string: When the Silencing Rule was created - `creator` ApiCreator - `avatar_url` string: The creator's avatar URL; null when the account could not be resolved - `email` string: The creator's email; null when the account could not be resolved - `id` string, uuid: The Account ID of the user that created the Silencing Rule - `name` string: The creator's name; null when the account could not be resolved - `delete_on_expiry` boolean: 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 - `disabled` boolean: true if the Silencing Rule is Disabled - `host_labels` object: The host label key-values targeting the Nodes the Silencing Rule applies to - `id` string, uuid: The Silencing Rule ID - `integration_ids` string[]: The Alert Notification Methods Integration IDs to which the Silencing Rule is applicable - `lasts_until` string: The end of the time window during which the Silencing Rule is applicable - `name` string: The Silencing Rule friendly name - `node_ids` string[]: The Node IDs to which the Silencing Rule is applicable - `notification_options` string[]: The Notification Options to which the Silencing Rule is applicable - `read_only` boolean: true if the Silencing Rule is ReadOnly and cannot be edited - `room_ids` string[]: The Room IDs to which the Silencing Rule is applicable - `rrule` string: 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_at` string: The beginning of the time window during which the Silencing Rule is applicable - `state` 'INACTIVE' | 'ACTIVE' | 'SCHEDULED': The current state of the Silencing Rule - `timezone` string: 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. ## Other responses - `400`: `"errorCode": "ErrBadRequest"`: when the Silencing Rule ID or request payload is invalid. Per-field validation errors are returned in case of invalid Silencing Rule definition - `401`: `"errorCode": "ErrUnauthorized"`: when the provided user token/cookie cannot be matched with an account - `403`: `"errorCode": "ErrForbidden"`: when caller is not authorized to access the space or update an Alert Notification Silencing Rule - `404`: `"errorCode": "ErrNotFound"`: when the Silencing Rule to be updated was not found - `422`: `"errorCode": "ErrUnprocessableEntity"`: when invalid spaceID is provided. - `500`: `"errorCode": "ErrInternal"`: when some Internal Server Error has occurred --- [API](https://skmtc.dev/netdata/apis/netdata-cloud-api.md) - [All operations](https://skmtc.dev/netdata/apis/netdata-cloud-api/llms.txt) - [OpenAPI document](https://skmtc.dev/netdata/apis/netdata-cloud-api/revisions/902a6689b462?raw)