Backup Archive

Before you begin

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

ADC > Backup & Restore > Backup now

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

Request Structure


Endpoint:	`/adc-device-archives`
Type:	`GET`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/adc-device-archives?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
backupName `String`	(Mandatory) Name of the backup.
archiveObject `Object`	(Mandatory) Details of the archive object. See archiveObject.

Table 2. archiveObject

restoreArchiveFileId `String`	(Mandatory) ID of the restore archive file.
rollBackArchiveFileId `String`	(Mandatory) ID of the roll back archive file.
reasonForRestore `String`	(Mandatory) Restore reason. It is a free-form field.
isDeviceRestore `Boolean`	(Mandatory) Device restore status. Possible values: true, false
restoreArchiveFileName `String`	(Mandatory) Name of the restore archive file.
rollBackArchiveFileName `String`	(Mandatory) Name of the roll back archive file.

Response Structure

Status Code: 200 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	More info in case of failure response.

Status Codes


HTTP Status Code	appStatusCode	Message	Possible remediation
200 Accepted	-	null	-
400 Bad Request	ADC_INV_2006	Invalid input.	Check if a non-null/non-empty value is given under field ‘payload’.

Sample Request/Response

Use Case

Fetch the backup archive by providing the device name and archive details..

Request URL

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

Sample Request

{
        "deviceName": "192.168.147.21",
        "archiveObject": {
            "restoreArchiveFileId": "68c152afc4c3ed31ccacbb68",
            "rollBackArchiveFileId": "68c152afc4c3ed31ccacbb68",
            "reasonForRestore": "",
            "isDeviceRestore": "true",
            "restoreArchiveFileName": "192.168.147.21_1757500079000.tar.gz",
            "rollBackArchiveFileName": "192.168.147.21_1757500074000.tar.gz"
        }

Sample Response

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

Search for Device Groups