ARarubanetworks
Notification Rules

Update a notification rule

This API is used to update a notification rule.

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

Request

Path parameters

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

ID of the notification rule.

Request body

Example request

{
  "notificationRuleInput": {
    "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"
        ]
      }
    }
  }
}

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"
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.