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

# PUT alarms/clearByEventType

Clears all alarms with provided event type

Since Product Version: 3.3

- 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 Write
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/alarms/clearByEventType

## Request Parameters

Attribute | Source | Description
--- | --- | ---
setSeverityToInfo Boolean | query | Optional True if need to set alarm severity to Info once it's cleared. False by default

## Request Payload Parameters

Attribute | Description
--- | ---
eventType String | Required Alarm event type

## 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/alarms/clearByEventType

    <?xml version="1.0" ?>
    <eventTypeDTO>
      <eventType>String value</eventType>
    </eventTypeDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v1/op/alarms/clearByEventType.json

    {
      "eventTypeDTO" : {
        "eventType" : "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 Write
HTTP Methods | PUT

## Resource URL

/webacs/api/v2/op/alarms/clearByEventType

Unmodified

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

## Request Parameters

Attribute | Source | Description
--- | --- | ---
setSeverityToInfo Boolean | query | Optional True if need to set alarm severity to Info once it's cleared. False by default

## Request Payload Parameters

Attribute | Description
--- | ---
eventType String | Required Alarm event type

## 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/alarms/clearByEventType

    <?xml version="1.0" ?>
    <eventTypeDTO>
      <eventType>String value</eventType>
    </eventTypeDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v2/op/alarms/clearByEventType.json

    {
      "eventTypeDTO" : {
        "eventType" : "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 Write
HTTP Methods | PUT

## Resource URL

/webacs/api/v3/op/alarms/clearByEventType

Unmodified

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

## Request Parameters

Attribute | Source | Description
--- | --- | ---
setSeverityToInfo Boolean | query | Optional True if need to set alarm severity to Info once it's cleared. False by default

## Request Payload Parameters

Attribute | Description
--- | ---
eventType String | Required Alarm event type

## 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/alarms/clearByEventType

    <?xml version="1.0" ?>
    <eventTypeDTO>
      <eventType>String value</eventType>
    </eventTypeDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v3/op/alarms/clearByEventType.json

    {
      "eventTypeDTO" : {
        "eventType" : "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 Write
HTTP Methods | PUT

## Resource URL

/webacs/api/v4/op/alarms/clearByEventType

Unmodified

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

## Request Parameters

Attribute | Source | Description
--- | --- | ---
setSeverityToInfo Boolean | query | Optional True if need to set alarm severity to Info once it's cleared. False by default

## Request Payload Parameters

Attribute | Description
--- | ---
eventType String | Required Alarm event type

## 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/alarms/clearByEventType

    <?xml version="1.0" ?>
    <eventTypeDTO>
      <eventType>String value</eventType>
    </eventTypeDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v4/op/alarms/clearByEventType.json

    {
      "eventTypeDTO" : {
        "eventType" : "String value"
      }
    }