Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Notification Rules

List all notification rules

This API endpoint retrieves the list of notification rules. The notification rules list includes data source and destination channel details. NOTE: The source.alerts.alertCount field in responses is a summary count; use getNotificationRuleV1 to retrieve the full list of alertNames

get/network-notifications/v1/notification-rules

Query parameters

limitinteger

Specifies the number of results to be returned.

offsetinteger

Specifies the zero-based resource offset from which to start the response.

Example:10

Response

List of notification rules.

offsetinteger

Specifies the offset of the returned page.

countinteger required

The number of objects returned in the current list.

totalinteger

The total number of objects contained in the datastore.

Example response

{
  "items": [
    {
      "id": "3f96ffea-73fe-4a9b-b253-ddc58c76fe25",
      "name": "email-rule",
      "description": "Notification rule for email alerts.",
      "enabled": true,
      "source": {
        "alerts": {
          "enabled": true,
          "alertCount": 10
        }
      },
      "destination": {
        "email": {
          "enabled": true,
          "emailIds": [
            "admin@domain.com"
          ]
        },
        "webhook": {
          "enabled": true,
          "webhookIds": [
            "4d113fgh-abcd-ef"
          ]
        },
        "syslog": {
          "enabled": true,
          "serverIds": [
            "4d113fgh-abcd-ef"
          ]
        }
      }
    }
  ],
  "count": 100,
  "total": 200
}