
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

# PUT settings/notification/alarmCategories

Updates current alarms notification settings

Since Product Version: 3.2

- Jump To

- v1
- v2
- v3
- v4

### 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

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

## Resource URL

/webacs/api/v1/op/settings/notification/alarmCategories

## Request Payload Parameters

Attribute | Description
--- | ---
alarmCategoriesSettings AlarmCategoryNotificationSettingsDTO[] | Required Array of notification settings per alarm category (at least one category is required)
Attribute | Description
--- | ---
categoryName String | Required Name of alarm category that notification settings belongs to
includeCritical Boolean | Indicates if we should send notifications for Critical alarms (optional, default value will be "false")
includeMajor Boolean | Indicates if we should send notifications for Major alarms (optional, default value will be "false")
includeMinor Boolean | Indicates if we should send notifications for Minor alarms (optional, default value will be "false")
includeWarning Boolean | Indicates if we should send notifications for Warning alarms (optional, default value will be "false")
isNotificationEnabled Boolean | Indicates if we should send notifications for this alarm category (optional, default value will be "false")
toAddress String | Required Comma separated list of mail notification recipients

## 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://10.64.88.203/webacs/api/v1/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://10.64.88.203/webacs/api/v1/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"
          }]
        }
      }
    }

### 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/v2/op/settings/notification/alarmCategories

Unmodified

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

## Request Payload Parameters

Attribute | Description
--- | ---
alarmCategoriesSettings AlarmCategoryNotificationSettingsDTO[] | Required Array of notification settings per alarm category (at least one category is required)
Attribute | Description
--- | ---
categoryName String | Required Name of alarm category that notification settings belongs to
includeCritical Boolean | Indicates if we should send notifications for Critical alarms (optional, default value will be "false")
includeMajor Boolean | Indicates if we should send notifications for Major alarms (optional, default value will be "false")
includeMinor Boolean | Indicates if we should send notifications for Minor alarms (optional, default value will be "false")
includeWarning Boolean | Indicates if we should send notifications for Warning alarms (optional, default value will be "false")
isNotificationEnabled Boolean | Indicates if we should send notifications for this alarm category (optional, default value will be "false")
toAddress String | Required Comma separated list of mail notification recipients

## 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://10.64.88.203/webacs/api/v2/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://10.64.88.203/webacs/api/v2/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"
          } ]
        }
      }
    }

### 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/v3/op/settings/notification/alarmCategories

Unmodified

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

## Request Payload Parameters

Attribute | Description
--- | ---
alarmCategoriesSettings AlarmCategoryNotificationSettingsDTO[] | Required Array of notification settings per alarm category (at least one category is required)
Attribute | Description
--- | ---
categoryName String | Required Name of alarm category that notification settings belongs to
includeCritical Boolean | Indicates if we should send notifications for Critical alarms (optional, default value will be "false")
includeMajor Boolean | Indicates if we should send notifications for Major alarms (optional, default value will be "false")
includeMinor Boolean | Indicates if we should send notifications for Minor alarms (optional, default value will be "false")
includeWarning Boolean | Indicates if we should send notifications for Warning alarms (optional, default value will be "false")
isNotificationEnabled Boolean | Indicates if we should send notifications for this alarm category (optional, default value will be "false")
toAddress String | Required Comma separated list of mail notification recipients

## 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://10.64.88.203/webacs/api/v3/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://10.64.88.203/webacs/api/v3/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"
          } ]
        }
      }
    }

### 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 AlarmCategoryNotificationSettingsDTO[] | Required Array of notification settings per alarm category (at least one category is required)
Attribute | Description
--- | ---
categoryName String | Required Name of alarm category that notification settings belongs to
includeCritical Boolean | Indicates if we should send notifications for Critical alarms (optional, default value will be "false")
includeMajor Boolean | Indicates if we should send notifications for Major alarms (optional, default value will be "false")
includeMinor Boolean | Indicates if we should send notifications for Minor alarms (optional, default value will be "false")
includeWarning Boolean | Indicates if we should send notifications for Warning alarms (optional, default value will be "false")
isNotificationEnabled Boolean | Indicates if we should send notifications for this alarm category (optional, default value will be "false")
toAddress String | Required Comma separated list of mail notification recipients

## 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://10.64.88.203/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://10.64.88.203/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"
          } ]
        }
      }
    }