This operation deletes devices in a synchronized way which may take a long time to respond. Use the Delete devices through job (POST /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 URL
/webacs/api/v1/op/devices/deleteDevicesRequest Payload Parameters
Type | Attribute Name | Description |
---|---|---|
String[] |
ipAddresses |
A list IPs of devices to be deleted |
Response Parameters
Type | Attribute Name | Description |
---|---|---|
deleteStatus |
A list of the delete operation results |
|
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://172.25.123.114/webacs/api/v1/op/devices/deleteDevices
<?xml version="1.0" ?> <deviceDeleteCandidates> <ipAddresses> <ipAddress>String value</ipAddress> </ipAddresses> </deviceDeleteCandidates>
Sample JSON Request Payload
https://172.25.123.114/webacs/api/v1/op/devices/deleteDevices.json
{ "deviceDeleteCandidates" : { "ipAddresses" : { "ipAddress" : "String value" } } }
Sample XML Response Payload
https://172.25.123.114/webacs/api/v1/op/devices/deleteDevices
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/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://172.25.123.114/webacs/api/v1/op/devices/deleteDevices.json
{ "mgmtResponse" : { "@responseType" : "operation", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/devices\/deleteDevices", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/", "deleteDeviceResult" : { "deleteStatuses" : { "deleteStatus" : { "ipAddress" : "String value", "message" : "String value", "status" : "String value" } }, "message" : "String value" } } }