Skip to main content
Alerting & Response/Alert Routing & Policies

ReplaceAlertNotificationPolicies

Atomically replace all notification policies in a single transaction Fixed AU-ALERT-008: PRD §4 PUT semantics — atomically replace all notification policies.

PUT/api/v1/alerting/notification-policies

Operation ID

ReplaceAlertNotificationPolicies

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • policies
    List

    Complete set of policies to replace existing ones

    Example: (nested array)

    • name
      String

      Human-readable policy name

      Example: Critical Alert Routing

    • description
      String

      Description of the policy routing logic

      Example: Route critical alerts to ops channels

    • priority
      Integer

      Priority order for policy evaluation

      Example: 1

    • isDefault
      Boolean

      Whether this is the default catch-all policy

      Example: false

    • matchers
      List

      Label matchers for routing decisions

      Example: (nested array)

      • key
        String

        Whitelisted alert label key to match

        Example: severity

      • operator
        String

        Match operator: eq, neq, or regex

        Example: eq

      • value
        String

        Value used by the selected operator

        Example: critical

    • channelIds
      List

      Channel UUIDs to deliver notifications to

      Example: item1,item2

    • groupBy
      List

      Fields to group notifications by

      Example: item1,item2

    • groupWait
      Integer

      Seconds to wait before first notification

      Example: 30

    • groupInterval
      Integer

      Seconds between grouped batches

      Example: 300

    • repeatInterval
      Integer

      Seconds before repeating notification

      Example: 3600

    • sendResolved
      Boolean

      Enqueue resolved notifications for this policy. Omitted defaults to true, including batch replacement. Does not affect firing notifications or already queued recoveries.

      Example: false

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Resulting set of notification policies after replacement

    Example: (nested array)

    • uuid
      String

      Unique identifier of the policy

      Example: policy-001

    • name
      String

      Human-readable policy name

      Example: Critical Alert Routing

    • description
      String

      Description of the policy routing logic

      Example: Route critical alerts to ops channels

    • priority
      Integer

      Priority order for policy evaluation (lower = higher priority)

      Example: 1

    • isDefault
      Boolean

      Whether this is the default catch-all policy

      Example: false

    • matchers
      List

      Label matchers for routing decisions

      Example: (nested array)

      • key
        String

        Whitelisted alert label key to match

        Example: severity

      • operator
        String

        Match operator: eq, neq, or regex

        Example: eq

      • value
        String

        Value used by the selected operator

        Example: critical

    • channelIds
      List

      Channel UUIDs to deliver notifications to

      Example: item1,item2

    • groupBy
      List

      Fields to group notifications by

      Example: item1,item2

    • groupWait
      Integer

      Seconds to wait before sending first notification

      Example: 30

    • groupInterval
      Integer

      Seconds between grouped notification batches

      Example: 300

    • repeatInterval
      Integer

      Seconds before repeating a notification

      Example: 3600

    • status
      String

      Policy status: active or disabled

      Example: active

    • createDate
      String

      Timestamp when the policy was created

      Example: 2024-01-15T09:00:00Z

    • lastOpDate
      String

      Timestamp of the last policy modification

      Example: 2024-01-15T09:00:00Z

    • matchersDisplay
      List

      Read-only matcher display in Content-Language; preserves original order and duplicate conditions

      Example: (nested array)

      • key
        String

        Original alert label key from the matcher, such as rule_uuid or resource_type, preserved unchanged alongside its localized display name.

        Example: value

      • operator
        String

        Operator for this resource

        Example: value

      • value
        String

        Value for this resource

        Example: value

      • displayName
        String

        Display name for this resource

        Example: value

      • valueDisplayName
        String

        Empty when unresolved or inaccessible; regex/nregex preserve the expression.

        Example: value

    • sendResolved
      Boolean

      Whether this policy enqueues resolved notifications. Defaults to true; false is explicitly returned. Already queued deliveries and retries are unaffected. The built-in console policy always synchronizes resolved state.

      Example: false

  • Change Time

    AddedRequest body fields sendResolvedAddedResponse fields sendResolved
    View API
  • Change Time

    AddedResponse fields displayName, matchersDisplay, valueDisplayName
    View API