Get Backup Info

Get Backup Info

Returns the backup file details for the specified backup instance

Request
URI
GET
https://{api_host}/api/1.0.0/backups/{backup-name}
COPY
Path Parameters
string
backup-name
Required

Name of backup file name from which to retreive the additional details. For example: backup-2021-07-13T215410+0000.zip


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Backup of type(s) application/json
{
    "name": "string",
    "location": "string",
    "size": 0,
    "date": "string",
    "version": "string"
}
string
name
Optional

Name of the appliance backup file.

string
location
Optional

absolute path to appliance backup file.

integer As int64 As int64
size
Optional

Size of appliance backup file in bytes.

string
date
Optional

Creation date of the appliance backup file.

string
version
Optional

Full appliance build version.


404

backup-name value specified is not valid. Does not exist on transfer share.

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/1.0.0/backups/{backup-name}