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

# PUT devices/deleteDevices

Deprecated

This operation deletes devices in a synchronized way which may take a long time to respond. Use the Delete devices through job resource instead

An operation to delete devices by ip address. The response time of this service varies and depends on the status of the devices. The API accepts the hostname, the IP address, or the management address of the device to be deleted. Firstly, the API tries to find the device by its management address. Then, if it has not been found, the API tries to find it by IP address and hostname. If there are more than one device with the same IP address or hostname an error will be returned. In this case you should use management address to delete the device.

Since Product Version: 2.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 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/devices/deleteDevices

## Request Payload Parameters

Attribute | Description
--- | ---
ipAddresses String[] | Required A list of addresses of the devices to be deleted. Either the hostname, the IP address, or the management address can be passed in. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.

## Response Parameters

Attribute | Description
--- | ---
deleteStatus OperationStatus[] | A list of the delete operation results
Attribute | Description
--- | ---
ipAddress String | Management address of the device. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.
message String | A system generated message describing operation status
status String | the status of the operation performed on the device
message String | The message returned from the delete device operation

## 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/devices/deleteDevices

    <?xml version="1.0" ?>
    <deviceDeleteCandidates>
      <ipAddresses>
        <ipAddress>String value</ipAddress>
        <ipAddress>Another string value</ipAddress>
      </ipAddresses>
    </deviceDeleteCandidates>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v1/op/devices/deleteDevices.json

    {
      "deviceDeleteCandidates" : {
        "ipAddresses" : {
          "ipAddress" : ["String value",
          "Another string value"]
        }
      }
    }

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v1/op/devices/deleteDevices

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v1/op">
      <deleteDeviceResult>
        <deleteStatuses>
          <deleteStatus>
            <ipAddress>String value</ipAddress>
            <message>String value</message>
            <status>String value</status>
          </deleteStatus>
          <deleteStatus>
            <ipAddress>Another string value</ipAddress>
            <message>Another string value</message>
            <status>Another string value</status>
          </deleteStatus>
        </deleteStatuses>
        <message>String value</message>
      </deleteDeviceResult>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v1/op/devices/deleteDevices.json

    {
      "mgmtResponse" : {
        "@responseType" : "operation",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/op/devices/deleteDevices",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/op",
        "deleteDeviceResult" : {
          "deleteStatuses" : {
            "deleteStatus" : [{
              "ipAddress" : "String value",
              "message" : "String value",
              "status" : "String value"
            },
            {
              "ipAddress" : "Another string value",
              "message" : "Another string value",
              "status" : "Another string value"
            }]
          },
          "message" : "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/devices/deleteDevices

Unmodified

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

## Request Payload Parameters

Attribute | Description
--- | ---
ipAddresses String[] | Required A list of addresses of the devices to be deleted. Either the hostname, the IP address, or the management address can be passed in. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.

## Response Parameters

Attribute | Description
--- | ---
deleteStatus OperationStatus[] | A list of the delete operation results
Attribute | Description
--- | ---
ipAddress String | Management address of the device. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.
message String | A system generated message describing operation status
status String | the status of the operation performed on the device
message String | The message returned from the delete device operation

## 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/devices/deleteDevices

    <?xml version="1.0" ?>
    <deviceDeleteCandidates>
      <ipAddresses>
        <ipAddress>String value</ipAddress>
        <ipAddress>Another string value</ipAddress>
      </ipAddresses>
    </deviceDeleteCandidates>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v2/op/devices/deleteDevices.json

    {
      "deviceDeleteCandidates" : {
        "ipAddresses" : {
          "ipAddress" : [ "String value", "Another string value" ]
        }
      }
    }

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v2/op/devices/deleteDevices

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v2/op">
      <deleteDeviceResult>
        <deleteStatuses>
          <deleteStatus>
            <ipAddress>String value</ipAddress>
            <message>String value</message>
            <status>String value</status>
          </deleteStatus>
          <deleteStatus>
            <ipAddress>Another string value</ipAddress>
            <message>Another string value</message>
            <status>Another string value</status>
          </deleteStatus>
        </deleteStatuses>
        <message>String value</message>
      </deleteDeviceResult>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v2/op/devices/deleteDevices.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/op",
        "deleteDeviceResult" : [ {
          "deleteStatuses" : {
            "deleteStatus" : [ {
              "ipAddress" : "String value",
              "message" : "String value",
              "status" : "String value"
            }, {
              "ipAddress" : "Another string value",
              "message" : "Another string value",
              "status" : "Another string value"
            } ]
          },
          "message" : "String value"
        } ]
      }
    }

Resource unavailable for this API version

This resource was removed in API version 3.

Resource unavailable for this API version

This resource was removed in API version 3.