This operation deletes devices in a synchronized way which may take a long time to respond. Use the Delete devices through job resource (POST op/devices/removalJob) instead
An operation to delete devices by ip address. The response time of this service varies and depends on the status of the devices.
Since Product Version: 2.2
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
PUT |
DevNet Discussions
Resource URL
/webacs/api/v1/op/devices/deleteDevicesRequest Payload Parameters
Attribute | Description |
---|---|
ipAddresses String[] |
A list IPs of devices to be deleted |
Response Parameters
Attribute | Description |
---|---|
A list of the delete operation results |
|
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://localhost/webacs/api/v1/op/devices/deleteDevices
<?xml version="1.0" ?>
<deviceDeleteCandidates>
<ipAddresses>
<ipAddress>String value</ipAddress>
</ipAddresses>
</deviceDeleteCandidates>
Sample JSON Request Payload
https://localhost/webacs/api/v1/op/devices/deleteDevices.json
{
"deviceDeleteCandidates" : {
"ipAddresses" : {
"ipAddress" : "String value"
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v1/op/devices/deleteDevices
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/devices/deleteDevices" rootUrl="https://localhost/webacs/api/v1/op">
<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://localhost/webacs/api/v1/op/devices/deleteDevices.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/devices\/deleteDevices",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"deleteDeviceResult" : {
"deleteStatuses" : {
"deleteStatus" : {
"ipAddress" : "String value",
"message" : "String value",
"status" : "String value"
}
},
"message" : "String value"
}
}
}