Skip to main content
API Explorer|API Explorer
Alerting & Response/Alert Routing & Policies
PUTAlertingSince 1.0SynchronousAuth Required

ReplaceAlertNotificationPolicies

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • policiesListRequired

    Complete set of policies to replace existing ones

    Example: (nested array)

    • nameString

      Human-readable policy name

      Example: Critical Alert Routing

    • descriptionString

      Description of the policy routing logic

      Example: Route critical alerts to ops channels

    • priorityInteger

      Priority order for policy evaluation

      Example: 1

    • isDefaultBoolean

      Whether this is the default catch-all policy

      Example: false

    • matchersList

      Label matchers for routing decisions

      Example: (nested array)

      • keyString

        Label key to match against

        Example: severity

      • operatorString

        Match operator: eq, neq, regex, etc.

        Example: eq

      • valueString

        Value to match against

        Example: critical

    • channelIdsList

      Channel UUIDs to deliver notifications to

      Example: item1,item2

    • groupByList

      Fields to group notifications by

      Example: item1,item2

    • groupWaitInteger

      Seconds to wait before first notification

      Example: 30

    • groupIntervalInteger

      Seconds between grouped batches

      Example: 300

    • repeatIntervalInteger

      Seconds before repeating notification

      Example: 3600

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Resulting set of notification policies after replacement

    Example: (nested array)

    • uuidString

      Unique identifier of the policy

      Example: policy-001

    • nameString

      Human-readable policy name

      Example: Critical Alert Routing

    • descriptionString

      Description of the policy routing logic

      Example: Route critical alerts to ops channels

    • priorityInteger

      Priority order for policy evaluation (lower = higher priority)

      Example: 1

    • isDefaultBoolean

      Whether this is the default catch-all policy

      Example: false

    • matchersList

      Label matchers for routing decisions

      Example: (nested array)

      • keyString

        Label key to match against

        Example: severity

      • operatorString

        Match operator: eq, neq, regex, etc.

        Example: eq

      • valueString

        Value to match against

        Example: critical

    • channelIdsList

      Channel UUIDs to deliver notifications to

      Example: item1,item2

    • groupByList

      Fields to group notifications by

      Example: item1,item2

    • groupWaitInteger

      Seconds to wait before sending first notification

      Example: 30

    • groupIntervalInteger

      Seconds between grouped notification batches

      Example: 300

    • repeatIntervalInteger

      Seconds before repeating a notification

      Example: 3600

    • statusString

      Policy status: active or disabled

      Example: active

    • createDateString

      Timestamp when the policy was created

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

    • lastOpDateString

      Timestamp of the last policy modification

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

Endpoint

PUT/api/v1/alerting/notification-policies

/api/v1/alerting/notification-policies

Operation ID

ReplaceAlertNotificationPolicies

Permalink

Request Example

curl -X PUT '{host}/api/v1/alerting/notification-policies' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"policies":"(nested array)"}'

Response Example

200
{
  "items": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history