Delete Device

Before you begin

Before attempting to delete devices with this API, users must ensure the ACF permission ADC > Inventory > Delete is available. This can be checked under Accounts > Role > Authorized Functions.

Request Structure

URL: /adc-device

Type: DELETE

Parameters

Table 1. Parameter Details
Param Type	Name	Description	Field Type	Constraints
Header	`sessionId`	Session ID received after login.	String	Required if username and password are not provided.
Header	`username`	AppViewX login username.	String	Required if sessionId is not provided.
Header	`password`	AppViewX login password.	String	Required if sessionId is not provided.
Header	`Content-Type`	Specifies the nature of the data in the payload.	String	Value of the param should be ‘application/json’.
Query	`gwkey`	Tenant Key. Needed only in case of multi-tenant installations.	String
Query	`gwsource`	Source from which the request is triggered (Eg: web, external).	String
Query	`deviceName`	Name of the device to be deleted	String	Mandatory. It can contain only alphanumeric characters, ‘-’ , ’_’ , ‘.’ , ‘*’ , ‘\|’, ‘!’.

Response Structure

On 200 OK, valid device(s) from the request will be deleted from the ADC inventory.


Name	Description	Field Type
response	Success message with device name or failure description in case of error.	String
message	Success message or failure description in case of error.	String
appStatusCode	Application-specific status code for the response. Will be non-null for failure response.	String
tags	More info in case of failure response, contains information of deleted and invalid device(s)

Status Codes


HTTP Status Code	appStatusCode	Message	Possible remediation
200 OK	-	Device(s) deleted succesfully.	-
400 Bad Request	ADC_INV_1562	Invalid Device Name. Device name cannot be null or empty.	Device name is not given/empty value is given. Give a valid device name in query param field - ‘deviceName’
400 Bad Request	ADC_INV_1561	All the given devices are invalid.	All the given device(s) are invalid. Check if the device is already added in the ADC inventory, Check if the requesting user has RW permission for the device.
404 Not Found	ADC_INV_1559	All the given devices are not found.	Check if the device is already added in the ADC inventory.
403 Forbidden	ADC_INV_1560	All the given devices doesn't have sufficient permission.	Check if the requesting user has RW permission for the device. This can be verified by navigating to Account -> Resource page and checking under Device tab for the user’s resource

Sample Request/Response

Use Case

Delete two devices, 192.168.40.150 and test available in the ADC inventory.

Request URL

https://192.168.98.27:31443/avxapi/adc-device?deviceName=192.168.40.150,test&gwkey=f000ca01&gwsource=api

Sample Request

NA

Sample Response

        {
  "appStatusCode": null,
  "headers": null,
  "message": "Device(s) deleted succesfully.",
  "response": "Device(s) deleted succesfully.",
  "tags": {
    "Deleted Device(s)": [
      "Inventory_Device_ADC_Delete_F5V13_StandAlone"
    ],
    "Invalid Device(s)": []
  }
}