Sync Configuration

Before you begin

Before attempting to initiate configuration sync with this API, users must ensure any one of the ACF permission is available:

ADC > Inventory > Fetch config

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

Request Structure


Endpoint:	`/adc-device-config-sync`
Type:	`PUT`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/adc-device-config-sync?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. 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 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
202 Accepted	-	Config sync triggered succesfully.	-
400 Bad Request	ADC_INV_1559	Invalid Device Name. Device name cannot be null or empty.	Check and ensure if non-null/non-empty value is given in field - ‘payload’. Check and ensure if non-null/non-empty value is given under payload field - ‘deviceName’.
400 Bad Request	AVX-VLDTN-001	Invalid payload data.	Requested value in the deviceName field does not match the accepted pattern.
404 Not Found	ADC_INV_0010	Device not found.	Check if the requested device is added in the inventory.
403 Forbidden	ADC_INV_0005	Config fetch not allowed for Unmanaged/Queued devices and Device(s) on which other operations are already in progress.	-
403 Forbidden	ADC_INV_1558	Cannot access resource, permission not available.	Check if Read/Read Write permission is available for the requested device.

Sample Request/Response

Use Case

Trigger configuration sync for the device - testDevice.

Request URL

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

Sample Request

{
  "payload": {
    "deviceName": "192.168.42.150"
  }
}

Sample Response

{
  "response": "Config sync triggered for given device - 192.168.42.150",
  "message": "Config sync triggered successfully.",
  "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

Get Object Configuration