Sync Configuration

Sync the device configuration details in AppViewX inventory with the details from the device.

URL: /adc-device-config-sync

Type: POST

Parameters

Param Type Name Description Field Type
Header sessionId ** Session Id received after login string
Query Gwkey Tenant Key. Needed only in case of multitenant installations string
Query gwsource** Source from which the request is triggered (Eg: web, external) String
Payload deviceName Name of the device String

** - Mandatory value

Possible Response Message and Code

HTTP Code Description Response Message
404 Not found Invalid Device Name
400 Bad request This field should not be null/empty and should match pattern …
403 Forbidden Config fetch not allowed for Unmanaged/Queued devices and Device(s) on which other operations are already in progress
202 Accepted Config sync triggered successfully

Sample Request/Response

Use Case

Perform sync configuration for the device ADC_GTM_1

Request URL

http://appviewxapi.com/avxapi/adc-device-config-sync?gwkey=f000ca01&gwsource=external

Request Payload

{

"payload": {

"deviceName": "ADC_GTM_1"

}

}

Response

{

"response": "Config sync triggered for given device - ADC_GTM_1",

"message": "Config sync triggered successfully.",

"tags": null

}