An operation to delete devices by ip address. The response time of this service varies and depends on the status of the devices.
Resource URL
/webacs/api/v1/op/devices/deleteDevices
Since : 2.2
Request Payload Parameters
String[]
|
ipAddresses
|
A list IPs of devices to be deleted
|
Response Parameters
OperationStatus[]
|
deleteStatus
|
A list of the delete operation results
|
String
|
ipAddress
|
The ip address of the device
|
String
|
message
|
A system generated message describing operation status
|
String
|
status
|
the status of the operation performed on the device
|
|
String
|
message
|
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://szier-m8-106.cisco.com/webacs/api/v1/op/devices/deleteDevices
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<deviceDeleteCandidates>
<ipAddresses>
<ipAddress>String value</ipAddress>
</ipAddresses>
</deviceDeleteCandidates>
Sample JSON Request Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/devices/deleteDevices.json
{
"deviceDeleteCandidates" : {
"ipAddresses" : {
"ipAddress" : "String value"
}
}
}
Sample XML Response Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/devices/deleteDevices
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/" requestUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/devices/deleteDevices" responseType="operation">
<deleteDeviceResult>
<deleteStatuses>
<deleteStatus>
<ipAddress>String value</ipAddress>
<message>String value</message>
<status>String value</status>
</deleteStatus>
</deleteStatuses>
<message>String value</message>
</deleteDeviceResult>
</mgmtResponse>
Sample JSON Response Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/devices/deleteDevices.json
{
"mgmtResponse" : {
"@rootUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/",
"@requestUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/devices\/deleteDevices",
"@responseType" : "operation",
"deleteDeviceResult" : {
"deleteStatuses" : {
"deleteStatus" : {
"ipAddress" : "String value",
"message" : "String value",
"status" : "String value"
}
},
"message" : "String value"
}
}
}