Veeam Backup for AWS 9
REST API Reference
Related documents

Configuration Backup and Restore

The /configurationBackup resource collection allows you to back up and restore the configuration database of the backup appliance.

Get Configuration Backup Settings

The HTTP GET request to the /configurationBackup/settings endpoint retrieves settings configured to perform backup of the Veeam Backup for AWS configuration database.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/configurationBackup/settings
Request samples 
curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/configurationBackup/settings \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
application/json
{
  • "isEnabled": true,
  • "modifiedBy": "string",
  • "modificationTime": "2019-08-24T14:15:22Z",
  • "backupOptions": {
    },
  • "scheduleOptions": {
    },
  • "includeSessionHistory": true
}

Modify Configuration Backup Settings

The HTTP PUT request to the /configurationBackup/settings endpoint changes settings configured to perform backup of the Veeam Backup for AWS configuration database.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Request Body schema: application/json
required
required
object (ConfigurationBackupPolicyBackupSpecification)

Specifies a location where the backup files will be stored.

required
object (ConfigurationBackupScheduleSettings)

Specifies schedule and retention settings for automatic configuration backup.

isEnabled
boolean

Defines whether to enable automatic backup according to the configured schedule.

includeSessionHistory
boolean

Defines whether to back up all session history. By default, Veeam Backup for AWS saves only restore session records.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

put/api/v1/configurationBackup/settings
Request samples
application/json
{
  • "isEnabled": true,
  • "scheduleOptions": {
    },
  • "includeSessionHistory": true,
  • "backupOptions": {
    }
}
Response samples
application/json
{
  • "isEnabled": true,
  • "modifiedBy": "string",
  • "modificationTime": "2019-08-24T14:15:22Z",
  • "backupOptions": {
    },
  • "scheduleOptions": {
    },
  • "includeSessionHistory": true
}

Enable Configuration Backup Schedule

The HTTP POST request to the /configurationBackup/enable endpoint enables the disabled configuration backup schedule.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/configurationBackup/enable
Request samples 
curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/configurationBackup/enable \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{ }

Disable Configuration Backup Schedule

The HTTP POST request to the /configurationBackup/disable endpoint disables the enabled configuration backup schedule.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/configurationBackup/disable
Request samples 
curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/configurationBackup/disable \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{ }

Get Configuration Backup Restore Points

The HTTP GET request to the /configurationBackup/restorePoints endpoint retrieves a list of all restore points created for the Veeam Backup for AWS configuration database.

SecurityBearer
Request
query Parameters
Offset
integer <int32> >= 0

Excludes from a response the first N items of a resource collection.

Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection to return in a response.

Sort
Array of strings

Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Sort Parameter.

Items Enum: "creationTimeUtcAsc" "creationTimeUtcDesc"
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/configurationBackup/restorePoints
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/configurationBackup/restorePoints?Offset=0&Limit=-1&Sort=creationTimeUtcAsc' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
application/json
{
  • "results": [
    ],
  • "totalCount": 0
}

Get Configuration Backup Restore Point Data

The HTTP GET request to the /configurationBackup/restorePoints/{restorePointId} endpoint retrieves information on a specific restore point created for the Veeam Backup for AWS configuration database.

SecurityBearer
Request
path Parameters
restorePointId
required
string <uuid>

Specifies the system ID assigned to a restore point in the Veeam Backup for AWS REST API.

header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/configurationBackup/restorePoints/{restorePointId}
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/configurationBackup/restorePoints/{restorePointId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "creationTimeUtc": "2019-08-24T14:15:22Z",
  • "jobType": "ManualBackup",
  • "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
  • "instanceId": "string",
  • "size": 0,
  • "product": {
    },
  • "counters": {
    },
  • "immutabilityInfo": {
    }
}

Remove Configuration Backup Restore Point

The HTTP DELETE request to the /configurationBackup/restorePoints/{restorePointId} endpoint deletes a specific restore point created for the Veeam Backup for AWS configuration database.

SecurityBearer
Request
path Parameters
restorePointId
required
string <uuid>

Specifies the system ID assigned to a restore point in the Veeam Backup for AWS REST API.

header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
202

Accepted

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

delete/api/v1/configurationBackup/restorePoints/{restorePointId}
Request samples 
curl -i -X DELETE \
  'https://helpcenter.veeam.com/api/v1/configurationBackup/restorePoints/{restorePointId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}

Create Configuration Backup

The HTTP POST request to the configurationBackup/backup endpoint creates a manual backup of the Veeam Backup for AWS configuration database.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Request Body schema: application/json
required
repositoryId
required
string <uuid>

Specifies the system ID assigned in the Veeam Backup for AWS REST API to a repository where the configuration backup will be stored.
Note: Configuration backup files can be stored only in an encrypted repository of the S3 Standard class.

backupSession
boolean

Defines whether all session history will be backed up. By default, only restore session records are saved.

Responses
202

Accepted

400

Bad Request. The request body is malformed, incomplete or invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

409

The policy has already started.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/configurationBackup/backup
Request samples
application/json
{
  • "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
  • "backupSession": true
}
Response samples
{}

Restore Backup Appliance Configuration

The HTTP POST request to the configurationBackup/restore endpoint launches restore of the backup appliance configuration using a specific restore point or an imported backup file.

NOTE
To perform configuration restore from an imported backup file, first import the file as described in section Import Configuration Backup File.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Request Body schema: application/json
required
restoreSource
required
string (EConfigurationRestoreSourceType)

Specifies whether to resore configuration from an imported backup file or using a restore point.

Enum: "RestorePoint" "File"
required
object (StartConfigurationRestoreOptions)

Specifies additional restore options.

object (ConfigurationRestoreRestorePointSource)

[Applies if the RestorePoint value is specified for the restoreSource parameter] Specifies a location of the restore point.

object (ConfigurationRestoreBackupFileSource)

[Applies if the File value is specified for the restoreSource parameter] Specifies a backup file that will be used for the restore operation.

rollbackAfterFail
boolean

Defines whether to perform the rollback operation in case of restore fails.

Responses
202

Accepted

400

Bad Request. The request body is malformed, incomplete or invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

409

The policy has already started.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/configurationBackup/restore
Request samples
application/json
{
  • "restoreSource": "RestorePoint",
  • "restorePointSource": {
    },
  • "backupFileSource": {
    },
  • "restoreOptions": {
    },
  • "rollbackAfterFail": true
}
Response samples
{}

Check Configuration

The HTTP POST request to the configurationBackup/restore/check endpoint launches checks for the restored configuration. This request must be performed to verify whether the backup appliance is ready to work properly after the restore operation.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

409

The policy has already started.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/configurationBackup/restore/check
Request samples 
curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/configurationBackup/restore/check \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{ }

Get Configuration Check Results

The HTTP GET request to the configurationBackup/restore/check/status endpoint retrieves information on performed configuration checks.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

409

The policy has already started.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/configurationBackup/restore/check/status
Request samples 
curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/configurationBackup/restore/check/status \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "overallStatus": "Success",
  • "logLines": [
    ]
}

Complete Configuration Restore

The HTTP POST request to the configurationBackup/restore/complete endpoint completes the restore operation of the backup appliance configuration.

NOTE
Before you complete the restore operation, it is recommended that you perform Configuration Check.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

409

The policy has already started.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/configurationBackup/restore/complete
Request samples 
curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/configurationBackup/restore/complete \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "message": "string"
}

Start Configuration Backup Export

The HTTP POST request to the configurationBackup/export/start endpoint launches an export operation for a specific configuration backup file.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Request Body schema: application/json
required

Specifies the backup file that will be exported.

restorePointId
required
string <uuid>

Specifies the system ID assigned in Veeam Backup for AWS to a restore point assosiated with the configuration backup that will be exported.

password
required
string

Specifies a password that will be used to encrypt the exported backup file.

passwordHint
required
string

Specifies a hint to the password.

Responses
202

Accepted

400

Bad Request. The request body is malformed, incomplete or invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

409

The policy has already started.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/configurationBackup/export/start
Request samples
application/json
{
  • "restorePointId": "8c843d10-6d0f-4abe-b898-e1ba18b94f68",
  • "password": "string",
  • "passwordHint": "string"
}
Response samples
{
  • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}

Check Status of Configuration Backup Export

The HTTP GET request to the configurationBackup/export/status/{sessionId} endpoint allows to check whether the exported configuration backup file is ready for download.

SecurityBearer
Request
path Parameters
sessionId
required
string <uuid>

Specifies the system ID assigned to an export session in the Veeam Backup for AWS REST API.

header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/configurationBackup/export/status/{sessionId}
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/configurationBackup/export/status/{sessionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "initiator": "string",
  • "createTimeUtc": "2019-08-24T14:15:22Z",
  • "endTimeUtc": "2019-08-24T14:15:22Z",
  • "status": "Running",
  • "result": "Running",
  • "reason": "string",
  • "logs": [
    ]
}

Download Configuration Backup File

The HTTP POST request to the configurationBackup/export/download endpoint allows a user to download the exported configuration backup file.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Request Body schema: application/json
required

Specifies a session ID of a file export operation.

sessionid
required
string <uuid>

Specifies the system ID assigned to an export session in the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

409

The policy has already started.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/configurationBackup/export/download
Request samples
application/json
{
  • "sessionid": "3bbbed98-ee5f-4c05-ac40-ac8b8db8cbb6"
}
Response samples
"string"

Import Configuration Backup File

The HTTP POST request to the /configurationBackup/import endpoint allows you to upload a configuration backup file.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Request Body schema: multipart/form-data
required
backupFile
required
string <binary>

Specifies a configuration backup file to upload.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/configurationBackup/import
Request samples 
curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/configurationBackup/import \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: multipart/form-data' \
  -H 'x-api-version: 1.7-rev0' \
  -F backupFile=string
Response samples
application/json
{
  • "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc"
}

Remove Imported Configuration Backup File

The HTTP DELETE request to the /configurationBackup/import/{fileId} endpoint removes a specific imported configuration backup file if the file is not needed, for example if the file is corrupted or a user decided to use another file to restore the configuration.

NOTE
Imported backup files that are used for restore operations are removed automatically after the operations complete.

SecurityBearer
Request
path Parameters
fileId
required
string <uuid>

Specifies the system ID assigned to an imported configuration backup file in the Veeam Backup for AWS REST API.

header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
204

No Content

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

delete/api/v1/configurationBackup/import/{fileId}
Request samples 
curl -i -X DELETE \
  'https://helpcenter.veeam.com/api/v1/configurationBackup/import/{fileId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "errorCode": "AccessDenied",
  • "details": "string",
  • "instance": "http://example.com",
  • "data": {
    }
}

Check Imported Backup File

The HTTP POST request to the /configurationBackup/import/{fileId}/check endpoint verifies whether the imported configuration backup file is not corrupted.

SecurityBearer
Request
path Parameters
fileId
required
string <uuid>

Specifies the system ID assigned to an imported configuration backup file in the Veeam Backup for AWS REST API.

header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Request Body schema: application/json
required
backupFilePassword
required
string

Password that was used to encrypt the configuration backup file.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/configurationBackup/import/{fileId}/check
Request samples
application/json
{
  • "backupFilePassword": "string"
}
Response samples
{
  • "isValid": true,
  • "errors": [
    ]
}

Get List of Uploaded Configuration Backup Files

The HTTP POST request to the /configurationBackup/import/list endpoint retrieves a list of IDs of configuration backup files that were imported to the backup appliance and were not used to restore the configuration.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/configurationBackup/import/list
Request samples 
curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/configurationBackup/import/list \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
application/json
{
  • "results": [
    ],
  • "totalCount": 0
}

Get Configuration Backup and Restore Session Data

The HTTP GET request to the configurationBackup/session/{sessionId} endpoint retrieves information on a configuration backup or restore session with the specified ID."

SecurityBearer
Request
path Parameters
sessionId
required
string <uuid>

Specifies the system ID assigned to a session in the Veeam Backup for AWS REST API.

header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/configurationBackup/sessions/{sessionId}
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/configurationBackup/sessions/{sessionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "initiator": "string",
  • "createTimeUtc": "2019-08-24T14:15:22Z",
  • "endTimeUtc": "2019-08-24T14:15:22Z",
  • "status": "Running",
  • "result": "Running",
  • "reason": "string",
  • "logs": [
    ]
}