v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Notification Rules

Retrieve a notification rule by its ID

This API endpoint retrieves a notification rule based on the id provided. The notification rule includes data source and destination channel details.

get/network-notifications/v1/notification-rules/{id}

Path parameters

idstring required

Example:3f96ffea-73fe-4a9b-b253-ddc58c76fe25

ID of the notification rule.

Response

Notification rule.

idstring required

Unique identifier of the notification rule.

typestring required

Type identifier for the notification rule.

namestring required

Name of the notification rule.

descriptionstring

Description of the notification rule.

enabledboolean

Indicates whether the notification rule is enabled.

sourceTypesstring[]

List of source types for the notification rule.

Example response

{
  "id": "3f96ffea-73fe-4a9b-b253-ddc58c76fe25",
  "name": "email-rule",
  "description": "Notification rule for email alerts.",
  "enabled": true,
  "source": {
    "alerts": {
      "enabled": true,
      "alertNames": [
        "AP CPU Utilization"
      ]
    }
  },
  "destination": {
    "email": {
      "enabled": true,
      "emailIds": [
        "admin@domain.com"
      ]
    },
    "webhook": {
      "enabled": true,
      "webhookIds": [
        "4d113fgh-abcd-ef"
      ]
    },
    "syslog": {
      "enabled": true,
      "serverIds": [
        "4d113fgh-abcd-ef"
      ]
    }
  }
}