Restore Primary Backup

Restore Primary Backup

This will restore the specified backup of the postgresql DB of the appliance, as well as other vcd specific files. This api endpoint should only be executed on the current postgresql HA primary appliance. The task will fail on Standby and Application-Cell appliances.

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

File name of the backup package to be restored from the transfer share. For example: backup-2021-07-13T215410+0000.zip


Request Body
RestoreBodyInfo of type(s) application/json
Required
This request body class requires all of the following: InlineRestoreBodyInfo0 , InlineRestoreBodyInfo1
{
    "nfs": "192.168.100.1:/data/transfer",
    "httpCert": false,
    "consoleproxyCert": false,
    "pgmanagementCert": false
}
Authentication
This operation uses the following authentication methods.
Responses
202

Response Body is empty. Response includes Location header with URL to related task-id.

Operation doesn't return any data structure

Response Headers

string
Location

Task URL. Example: https://<vcd-appliance-ip>:5480/api/1.0.0/tasks/<task-id>


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"nfs:"string"}' https://{api_host}/api/1.0.0/backups/{backup-name}/restore