Delete Device

Before you begin

Before attempting to delete devices with this API, users must ensure the ACF permission is available:

ADC > Inventory > Delete

This can be checked under Accounts > Role > Authorized Functions.

Request Structure


Endpoint:	`/adc-device`
Type:	`DELETE`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/adc-device?gwsource=external` To understand the elements of the sample URL, click here.
Headers:
Content-Type:	application/json

Table 1. Input Parameter
Name	Description
sessionId `Header`	(Mandatory) Specifies the session ID of the user session received after login. Type: String Constraints: The session ID is used when username and password are not provided.
username `Header`	(Mandatory) Specifies the login username used to access the AppViewX. Type: String Constraints: The username, along with the password, is used when the session ID is not provided.
password `Header`	(Mandatory) Specifies the login password used to access the AppViewX. Type: String Constraints: The password, along with the username, is used when the session ID is not provided.
Content-Type `Header`	(Mandatory) Specifies the format of the data in the payload. Type: String Constraints: The value of this param must be ‘application/json’.
gwsource `Query`	(Mandatory) Specifies the source from which the request is triggered. The options are: web external Type: String
deviceName `Query`	(Mandatory) Name of the device to be deleted. Constraints: It can contain only alphanumeric characters, ‘-’ , ’_’ , ‘.’ , ‘*’ , ‘\|’, ‘!’.

Response Structure

Status Code: 200 OK
Message: Successful
Headers:
- Content-Type: application/json


Name	Description
response `String`	Success message with device name or failure description in case of error.
message `String`	Success message or failure description in case of error.
appStatusCode `String`	Application specific status code for the response. Will be non-null for failure response.
tags `String`	More info in case of failure response.

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://<IP/HostName/TenantName>:<GWPORT>/avxapi/adc-device

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)": []
  }
}

Reference

Understanding the sample URL:

IP/HostName/TenantName: Replace with the actual IP address, hostname, or tenant name based on the specific configuration in AppViewX.
- IP: A unique identifier assigned to each device connected to a computer network that uses the Internet Protocol for communication
  The IP address will be included in the endpoint URL for an on-prem deployment.
- HostName: A human-readable label assigned to a device (host) on a network
  The hostname will be included in the endpoint URL for an on-prem deployment.
- TenantName: An identifier label for a tenant given to indicate which tenant's data the API request will access/modify
  The tenant name will be included in the endpoint URL for a SaaS deployment.
GWPORT: AppViewX gateway port
A gateway port refers to a network port through which data is sent and received to communicate with a gateway in an on-prem deployment.
Example: 31443
avxapi: Path parameter value (static) that is part of the endpoint's URL
Endpoint: Endpoint of the API, for example: execute-hook
gwsource: Source or origin of a gateway, for example: external.

What's Next

Add Device