Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

PUT settings/notification/alarmCategories

Updates current alarms notification settings

Since Product Version: 3.2

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Credential

HTTP Methods

PUT

Resource URL

/webacs/api/v4/op/settings/notification/alarmCategories

Unmodified

This resource has not been modified since the previous API version.

Request Payload Parameters

Attribute Description

alarmCategoriesSettings Arrow image AlarmCategoryNotificationSettingsDTO[]

Required

Array of notification settings per alarm category (at least one category is required)

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Request Payload

https://localhost/webacs/api/v4/op/settings/notification/alarmCategories

<?xml version="1.0" ?>
<alarmsNotificationSettingsDTO>
  <alarmCategoriesSettings>
    <alarmCategoriesSettings>
      <categoryName>String value</categoryName>
      <includeCritical>true</includeCritical>
      <includeMajor>true</includeMajor>
      <includeMinor>true</includeMinor>
      <includeWarning>true</includeWarning>
      <isNotificationEnabled>true</isNotificationEnabled>
      <toAddress>String value</toAddress>
    </alarmCategoriesSettings>
    <alarmCategoriesSettings>
      <categoryName>Another string value</categoryName>
      <includeCritical>false</includeCritical>
      <includeMajor>false</includeMajor>
      <includeMinor>false</includeMinor>
      <includeWarning>false</includeWarning>
      <isNotificationEnabled>false</isNotificationEnabled>
      <toAddress>Another string value</toAddress>
    </alarmCategoriesSettings>
  </alarmCategoriesSettings>
</alarmsNotificationSettingsDTO>

Sample JSON Request Payload

https://localhost/webacs/api/v4/op/settings/notification/alarmCategories.json

{
  "alarmsNotificationSettingsDTO" : {
    "alarmCategoriesSettings" : {
      "alarmCategoriesSettings" : [ {
        "categoryName" : "String value",
        "includeCritical" : true,
        "includeMajor" : true,
        "includeMinor" : true,
        "includeWarning" : true,
        "isNotificationEnabled" : true,
        "toAddress" : "String value"
      }, {
        "categoryName" : "Another string value",
        "includeCritical" : false,
        "includeMajor" : false,
        "includeMinor" : false,
        "includeWarning" : false,
        "isNotificationEnabled" : false,
        "toAddress" : "Another string value"
      } ]
    }
  }
}