Sync Configuration

This API triggers configuration sync for a device available in Device Inventory.

Before you begin

Before attempting to initiate configuration sync with this API, users must ensure any one of the ACF permission “ADC > Inventory > Fetch config” is available. This can be checked under Accounts > Role > Authorized Functions.

Request Structure

URL: /adc-device-config-sync

Type: POST

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
Body payload Contains all the params to be sent in the request body for the post request.

Key value pair.

Payload

Payload

Name Mandatory Description Field Type Constraints
deviceName Yes Name of the device. String

It can contain only alphanumeric characters, ‘-’ , ’_’ , ‘.’ , ‘*’ , ‘|’, ‘!’.

Response Structure

On 202 Accepted, configuration sync will be initiated on requested device and string of type application/json will be returned with the following body params:
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. Key value pair

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.

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

}