Take Device Backup

Triggers backup for a device. The backup will be stored in the AppViewX inventory.

URL: /adc-device-backup

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 backupName**

The name of the backup group. A group can have more than one backups. If the backup group name is already existing in the system, then the backup will happen only if one of the following conditions are met.

  • The backup group is not configured yet with any devices. In this case, the device will be automatically added to the group.
  • The backup group is already configured with the given device.
 String
Payload deviceName** Name of the device String

** - Mandatory value

Possible Response Message and Code

HTTP Code Description Response Message
202 Accepted Device backup triggered successfully
403 Forbidden Cannot access resource, permission not available.
403 Forbidden Action cannot be performed on unmanaged device object(s)
400 Bad request Respective vendor's device is not supported. Action cannot be performed
400 Bad request Mismatch in backup type, cannot add a device to the existing group as it already has a device group configured
404 Not found Device not available for the given details

Sample Request/Response

Use Case

Trigger a backup for the device ADC_GTM_1 with a backup name bkp_1. The backup for the device will be generated under the group bkp_1.

Request URL

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

Request Payload

{

"payload": {

"backupName": "bkp_1",

"deviceName": "ADC_GTM_1"

}

}

Response

{

"response": "Backup triggered for device ADC_GTM_1",

"message": "Device backup triggered successfully."

}