Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

DELETE trapReceiverService/receiver

Deprecated

Notification Receivers API is deprecated because Notification Receivers were replaced by Notification Policies. This resource will not delete receivers which (1) are used by more than one policy or (2) have other receivers associated with the same policy. This resource may be removed in a future release.

Deletes an existing northbound trap receiver destination and the associated notification policy.

The API supports only those trap receivers associated with one notification policy. If there is more than one policy mapped to the receiver, or the the policy is associated with any other receiver, then an explicit error will be thrown, and neither the receiver nor the policy will be deleted.

Since Product Version: 3.0

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

DELETE

DevNet Discussions

Resource URL

/webacs/api/v2/op/trapReceiverService/receiver

Unmodified

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

Request Parameters

Attribute Source Description

id String

query

Required

Response Parameters

Attribute Description

result String

The operation result message

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://localhost/webacs/api/v2/op/trapReceiverService/receiver?id=1282281

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/trapReceiverService/receiver?id=1282281" rootUrl="https://localhost/webacs/api/v2/op">
  <trapReceiverOutput>
    <result>String value</result>
  </trapReceiverOutput>
</mgmtResponse>

Sample JSON Response Payload

https://localhost/webacs/api/v2/op/trapReceiverService/receiver.json?id=1282281

{
  "mgmtResponse" : {
    "@requestUrl" : "https://localhost/webacs/api/v2/op/trapReceiverService/receiver?id=1282281",
    "@responseType" : "operation",
    "@rootUrl" : "https://localhost/webacs/api/v2/op",
    "trapReceiverOutput" : [ {
      "result" : "String value"
    } ]
  }
}