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

ListAlertNotificationPolicies

List all notification routing policies with pagination

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • pageInteger

    1-based page number; 0 means no pagination 1-based page number; 0 means no pagination

    Example: 0

  • pageSizeInteger

    Results per page; default 20, max 200 Results per page; default 20, max 200

    Example: 0

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    List of notification policies

    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

  • totalInteger

    Total number of policies

    Example: 3

  • limitInteger

    Maximum items per page

    Example: 20

  • offsetInteger

    Offset from start of result set

    Example: 20

Endpoint

GET/api/v1/alerting/notification-policies

/api/v1/alerting/notification-policies

Operation ID

ListAlertNotificationPolicies

Permalink

Request Example

curl -X GET '{host}/api/v1/alerting/notification-policies' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ],
  "total": 3,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history