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

# GET settings/alarms/severityAutoClearConfig

Retrieves existing configuration for alarms. Returns tree of alarm types groups containing all alarms with their severities and auto clear ages if configured.

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

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/alarms/severityAutoClearConfig

## Response Parameters

Attribute | Description
--- | ---
groups SeverityAutoClearConfigTree[] | Nested subgroups.
Attribute | Description
--- | ---
groups SeverityAutoClearConfigTree[] | Nested subgroups.
items PartialSeverityAutoClearConfigDto[] | Configurations for alarms types.
Attribute | Description
--- | ---
alarmCondition String | Condition triggering alarms of this type
alarmType String | Name of this alarm type
autoClearAge Integer | Time in hours before alarms triggered by the condition are cleared automatically
isAutoClearSupported boolean | Indicates if auto clear option is supported for this alarm type
severity AlarmSeverityLevelEnum | Severity level set for alarms triggered by the condition Allowed values INFORMATION WARNING MINOR MAJOR CRITICAL DEFAULT
name String | Name of group of alarms.
items PartialSeverityAutoClearConfigDto[] | Configurations for alarms types.
Attribute | Description
--- | ---
alarmCondition String | Condition triggering alarms of this type
alarmType String | Name of this alarm type
autoClearAge Integer | Time in hours before alarms triggered by the condition are cleared automatically
isAutoClearSupported boolean | Indicates if auto clear option is supported for this alarm type
severity AlarmSeverityLevelEnum | Severity level set for alarms triggered by the condition Allowed values INFORMATION WARNING MINOR MAJOR CRITICAL DEFAULT
name String | Name of group of alarms.

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

https://172.20.127.108/webacs/api/v1/op/settings/alarms/severityAutoClearConfig

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v1/op">
      <severityAutoClearConfigTree>
        <groups></groups>
        <items>
          <items>
            <alarmCondition>String value</alarmCondition>
            <alarmType>String value</alarmType>
            <autoClearAge>15</autoClearAge>
            <isAutoClearSupported>true</isAutoClearSupported>
            <severity>INFORMATION</severity>
          </items>
          <items>
            <alarmCondition>Another string value</alarmCondition>
            <alarmType>Another string value</alarmType>
            <autoClearAge>25</autoClearAge>
            <isAutoClearSupported>false</isAutoClearSupported>
            <severity>WARNING</severity>
          </items>
        </items>
        <name>String value</name>
      </severityAutoClearConfigTree>
    </mgmtResponse>

### Sample JSON Response Payload

https://172.20.127.108/webacs/api/v1/op/settings/alarms/severityAutoClearConfig.json

    {
      "mgmtResponse" : {
        "@responseType" : "operation",
        "@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op\/settings\/alarms\/severityAutoClearConfig",
        "@rootUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op",
        "severityAutoClearConfigTree" : {
          "groups" : "",
          "items" : {
            "items" : [{
              "alarmCondition" : "String value",
              "alarmType" : "String value",
              "autoClearAge" : 15,
              "isAutoClearSupported" : true,
              "severity" : "INFORMATION"
            },
            {
              "alarmCondition" : "Another string value",
              "alarmType" : "Another string value",
              "autoClearAge" : 25,
              "isAutoClearSupported" : false,
              "severity" : "WARNING"
            }]
          },
          "name" : "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 | GET

## Resource URL

/webacs/api/v2/op/settings/alarms/severityAutoClearConfig

Unmodified

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

## Response Parameters

Attribute | Description
--- | ---
groups SeverityAutoClearConfigTree[] | Nested subgroups.
Attribute | Description
--- | ---
groups SeverityAutoClearConfigTree[] | Nested subgroups.
items PartialSeverityAutoClearConfigDto[] | Configurations for alarms types.
Attribute | Description
--- | ---
alarmCondition String | Condition triggering alarms of this type
alarmType String | Name of this alarm type
autoClearAge Integer | Time in hours before alarms triggered by the condition are cleared automatically
isAutoClearSupported boolean | Indicates if auto clear option is supported for this alarm type
severity AlarmSeverityLevelEnum | Severity level set for alarms triggered by the condition Allowed values INFORMATION WARNING MINOR MAJOR CRITICAL DEFAULT
name String | Name of group of alarms.
items PartialSeverityAutoClearConfigDto[] | Configurations for alarms types.
Attribute | Description
--- | ---
alarmCondition String | Condition triggering alarms of this type
alarmType String | Name of this alarm type
autoClearAge Integer | Time in hours before alarms triggered by the condition are cleared automatically
isAutoClearSupported boolean | Indicates if auto clear option is supported for this alarm type
severity AlarmSeverityLevelEnum | Severity level set for alarms triggered by the condition Allowed values INFORMATION WARNING MINOR MAJOR CRITICAL DEFAULT
name String | Name of group of alarms.

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

https://172.20.127.108/webacs/api/v2/op/settings/alarms/severityAutoClearConfig

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v2/op">
      <severityAutoClearConfigTree>
        <groups></groups>
        <items>
          <items>
            <alarmCondition>String value</alarmCondition>
            <alarmType>String value</alarmType>
            <autoClearAge>15</autoClearAge>
            <isAutoClearSupported>true</isAutoClearSupported>
            <severity>INFORMATION</severity>
          </items>
          <items>
            <alarmCondition>Another string value</alarmCondition>
            <alarmType>Another string value</alarmType>
            <autoClearAge>25</autoClearAge>
            <isAutoClearSupported>false</isAutoClearSupported>
            <severity>WARNING</severity>
          </items>
        </items>
        <name>String value</name>
      </severityAutoClearConfigTree>
    </mgmtResponse>

### Sample JSON Response Payload

https://172.20.127.108/webacs/api/v2/op/settings/alarms/severityAutoClearConfig.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v2/op",
        "severityAutoClearConfigTree" : [ {
          "groups" : {
            "groups" : [ ]
          },
          "items" : {
            "items" : [ {
              "alarmCondition" : "String value",
              "alarmType" : "String value",
              "autoClearAge" : 15,
              "isAutoClearSupported" : true,
              "severity" : "INFORMATION"
            }, {
              "alarmCondition" : "Another string value",
              "alarmType" : "Another string value",
              "autoClearAge" : 25,
              "isAutoClearSupported" : false,
              "severity" : "WARNING"
            } ]
          },
          "name" : "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 | GET

## Resource URL

/webacs/api/v3/op/settings/alarms/severityAutoClearConfig

Unmodified

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

## Response Parameters

Attribute | Description
--- | ---
groups SeverityAutoClearConfigTree[] | Nested subgroups.
Attribute | Description
--- | ---
groups SeverityAutoClearConfigTree[] | Nested subgroups.
items PartialSeverityAutoClearConfigDto[] | Configurations for alarms types.
Attribute | Description
--- | ---
alarmCondition String | Condition triggering alarms of this type
alarmType String | Name of this alarm type
autoClearAge Integer | Time in hours before alarms triggered by the condition are cleared automatically
isAutoClearSupported boolean | Indicates if auto clear option is supported for this alarm type
severity AlarmSeverityLevelEnum | Severity level set for alarms triggered by the condition Allowed values INFORMATION WARNING MINOR MAJOR CRITICAL DEFAULT
name String | Name of group of alarms.
items PartialSeverityAutoClearConfigDto[] | Configurations for alarms types.
Attribute | Description
--- | ---
alarmCondition String | Condition triggering alarms of this type
alarmType String | Name of this alarm type
autoClearAge Integer | Time in hours before alarms triggered by the condition are cleared automatically
isAutoClearSupported boolean | Indicates if auto clear option is supported for this alarm type
severity AlarmSeverityLevelEnum | Severity level set for alarms triggered by the condition Allowed values INFORMATION WARNING MINOR MAJOR CRITICAL DEFAULT
name String | Name of group of alarms.

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

https://172.20.127.108/webacs/api/v3/op/settings/alarms/severityAutoClearConfig

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v3/op">
      <severityAutoClearConfigTree>
        <groups></groups>
        <items>
          <items>
            <alarmCondition>String value</alarmCondition>
            <alarmType>String value</alarmType>
            <autoClearAge>15</autoClearAge>
            <isAutoClearSupported>true</isAutoClearSupported>
            <severity>INFORMATION</severity>
          </items>
          <items>
            <alarmCondition>Another string value</alarmCondition>
            <alarmType>Another string value</alarmType>
            <autoClearAge>25</autoClearAge>
            <isAutoClearSupported>false</isAutoClearSupported>
            <severity>WARNING</severity>
          </items>
        </items>
        <name>String value</name>
      </severityAutoClearConfigTree>
    </mgmtResponse>

### Sample JSON Response Payload

https://172.20.127.108/webacs/api/v3/op/settings/alarms/severityAutoClearConfig.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v3/op",
        "severityAutoClearConfigTree" : [ {
          "groups" : {
            "groups" : [ ]
          },
          "items" : {
            "items" : [ {
              "alarmCondition" : "String value",
              "alarmType" : "String value",
              "autoClearAge" : 15,
              "isAutoClearSupported" : true,
              "severity" : "INFORMATION"
            }, {
              "alarmCondition" : "Another string value",
              "alarmType" : "Another string value",
              "autoClearAge" : 25,
              "isAutoClearSupported" : false,
              "severity" : "WARNING"
            } ]
          },
          "name" : "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 | GET

## Resource URL

/webacs/api/v4/op/settings/alarms/severityAutoClearConfig

Unmodified

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

## Response Parameters

Attribute | Description
--- | ---
groups SeverityAutoClearConfigTree[] | Nested subgroups.
Attribute | Description
--- | ---
groups SeverityAutoClearConfigTree[] | Nested subgroups.
items PartialSeverityAutoClearConfigDto[] | Configurations for alarms types.
Attribute | Description
--- | ---
alarmCondition String | Condition triggering alarms of this type
alarmType String | Name of this alarm type
autoClearAge Integer | Time in hours before alarms triggered by the condition are cleared automatically
isAutoClearSupported boolean | Indicates if auto clear option is supported for this alarm type
severity AlarmSeverityLevelEnum | Severity level set for alarms triggered by the condition Allowed values INFORMATION WARNING MINOR MAJOR CRITICAL DEFAULT
name String | Name of group of alarms.
items PartialSeverityAutoClearConfigDto[] | Configurations for alarms types.
Attribute | Description
--- | ---
alarmCondition String | Condition triggering alarms of this type
alarmType String | Name of this alarm type
autoClearAge Integer | Time in hours before alarms triggered by the condition are cleared automatically
isAutoClearSupported boolean | Indicates if auto clear option is supported for this alarm type
severity AlarmSeverityLevelEnum | Severity level set for alarms triggered by the condition Allowed values INFORMATION WARNING MINOR MAJOR CRITICAL DEFAULT
name String | Name of group of alarms.

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

https://172.20.127.108/webacs/api/v4/op/settings/alarms/severityAutoClearConfig

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v4/op">
      <severityAutoClearConfigTree>
        <groups></groups>
        <items>
          <items>
            <alarmCondition>String value</alarmCondition>
            <alarmType>String value</alarmType>
            <autoClearAge>15</autoClearAge>
            <isAutoClearSupported>true</isAutoClearSupported>
            <severity>INFORMATION</severity>
          </items>
          <items>
            <alarmCondition>Another string value</alarmCondition>
            <alarmType>Another string value</alarmType>
            <autoClearAge>25</autoClearAge>
            <isAutoClearSupported>false</isAutoClearSupported>
            <severity>WARNING</severity>
          </items>
        </items>
        <name>String value</name>
      </severityAutoClearConfigTree>
    </mgmtResponse>

### Sample JSON Response Payload

https://172.20.127.108/webacs/api/v4/op/settings/alarms/severityAutoClearConfig.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v4/op",
        "severityAutoClearConfigTree" : [ {
          "groups" : {
            "groups" : [ ]
          },
          "items" : {
            "items" : [ {
              "alarmCondition" : "String value",
              "alarmType" : "String value",
              "autoClearAge" : 15,
              "isAutoClearSupported" : true,
              "severity" : "INFORMATION"
            }, {
              "alarmCondition" : "Another string value",
              "alarmType" : "Another string value",
              "autoClearAge" : 25,
              "isAutoClearSupported" : false,
              "severity" : "WARNING"
            } ]
          },
          "name" : "String value"
        } ]
      }
    }