Unmanage a Device

Before you begin

Before attempting to manage devices with this API, users must ensure any one of the ACF permission is available:

ADC > Inventory > Manage / Unmanage

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

Request Structure


Endpoint:	`/adc-device-unmanage`
Type:	`PUT`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/adc-device-unmanage?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
payload `Body`	(Mandatory) Contains all the params to be sent in the request body for the post request. See Payload section for more details.

Payload


Name	Description
deviceName `String[]`	(Mandatory) Name of the device(s) to manage. Constraints: It can contain only alphanumeric characters, ‘-’ , ’_’ , ‘.’ , ‘*’ , ‘\|’, ‘!’.

Response Structure

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


Name	Description
response `String`	Success message 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
202 Accepted	-	State change to unmanage the device has been initiated.	-
400 Bad Request	ADC_INV_0234	Device name is mandatory.Value cannot be null or empty.	Check and ensure a valid value is provided in field deviceName.
400 Bad Request	AVX-VLDTN-001	Invalid payload data.	Check and ensure a valid value is provided in field payload.
404 Not Found	ADC_INV_0010	Device not found.	Any of the given devices are not found in the database. Ensure if all the requested devices are added in inventory
403 Forbidden	ADC_INV_0009	Selected device(s) are in in-progress/un-managed state. Operation cannot be performed.	All the requested devices are in unmanaged/inprogress state. Requested devices should not be in Inprogress/unmanaged state.

Sample Request/Response

Use Case

Change the state of device ADC_DEVICE_1 from managed to unmanaged.

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/adc-device-unmanage

Sample Request

{
  "payload": {
    "deviceName": [
      "ADC_DEVICE_1"
    ]
  }
}

Sample Response

{
  "response": "State change to unmanage the device has been initiated.",
  "message": "State change to unmanage the device has been initiated.",
  "appStatusCode": null,
  "tags": null,
  "headers": null
}

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

Manage Device