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

CreateAlertNotificationPolicy

Create a new notification routing policy

POST/api/v1/alerting/notification-policies

Operation ID

CreateAlertNotificationPolicy

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

  • name
    StringRequired

    Human-readable policy name

    Example: Critical Alert Routing

  • description
    StringRequired

    Description of the policy routing logic

    Example: Route critical alerts to ops channels

  • priority
    IntegerRequired

    Priority order for policy evaluation

    Example: 1

  • isDefault
    BooleanRequired

    Whether this is the default catch-all policy

    Example: false

  • matchers
    ListRequired

    Label matchers for routing decisions

    Example: (nested array)

    • key
      String

      Label key to match against

      Example: severity

    • operator
      String

      Match operator: eq, neq, regex, etc.

      Example: eq

    • value
      String

      Value to match against

      Example: critical

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • 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

      Label key to match against

      Example: severity

    • operator
      String

      Match operator: eq, neq, regex, etc.

      Example: eq

    • value
      String

      Value to match against

      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