Veeam Backup for Google Cloud 7
REST API Reference
Related documents

Configuration Backup

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

Create Configuration Backup

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

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

Specifies the current revision of the Veeam Backup for Google Cloud REST API.

Request Body schema: application/json
required

Specifies configuration backup settings.

includeSessionHistory
boolean

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

repositoryId
string <uuid>

Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to a repository where the configuration backup will be stored.

notificationEmail
string

Specifies the email address to receive notifications on session results.

shouldSendCompletionNotification
boolean

Defines whether to receive notifications on session results.

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 at the server side.

post/api/v1/configurationBackup/backup
Request samples
application/json
{
  • "includeSessionHistory": true,
  • "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
  • "notificationEmail": "string",
  • "shouldSendCompletionNotification": true
}
Response samples
application/json
{
  • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}

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.4-rev0

Specifies the current revision of the Veeam Backup for Google Cloud 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 at the server side.

post/api/v1/configurationBackup/enable
Request samples 
Response samples 
application/json
{ }
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.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud 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 at the server side.


post/api/v1/configurationBackup/disable
Request samples 
Response samples 
application/json
{ }
Get Configuration Backup Settings
The HTTP GET request to the /configurationBackup/settings endpoint retrieves settings configured to perform backup of the Veeam Backup for Google Cloud configuration database.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud 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 at the server side.


get/api/v1/configurationBackup/settings
Request samples 
Response samples 
application/json
{
  • "isEnabled": true,
  • "scheduleOptions": {
    },
  • "backupOptions": {
    },
  • "retryOptions": {
    },
  • "includeSessionHistory": true,
  • "modifiedBy": "string",
  • "modificationTime": "2019-08-24T14:15:22Z",
  • "vbrRepositoryName": "string",
  • "vbrRestorePointCount": 0
}
Modify Configuration Backup Settings
The HTTP PUT request to the /configurationBackup/settings endpoint changes settings configured to perform backup of the Veeam Backup for Google Cloud configuration database.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud REST API.


 
Request Body schema: application/json
required
Specifies settings that will be used to perform automatic configuration backup.


isEnabled
required
boolean
Defines whether to enable automatic backup creation according to the configured schedule.


 
required
object (ConfigurationBackupScheduleModel) 
Specifies schedule and retention settings for the configuration backup.


 
includeSessionHistory
required
boolean
Defines whether to back up all session history. By default, Veeam Backup for Google Cloud saves only restore session records.


 
object (ConfigurationBackupOptionsModel) 
Specifies a location where backup files will be stored.


 
object (RetryOptionsModel) 
Specifies the retry settings configured for the backup session.


 
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 at the server side.


put/api/v1/configurationBackup/settings
Request samples 
application/json
{
  • "isEnabled": true,
  • "scheduleOptions": {
    },
  • "backupOptions": {
    },
  • "retryOptions": {
    },
  • "includeSessionHistory": true
}
Response samples 
application/json
{
  • "isEnabled": true,
  • "scheduleOptions": {
    },
  • "backupOptions": {
    },
  • "retryOptions": {
    },
  • "includeSessionHistory": true,
  • "modifiedBy": "string",
  • "modificationTime": "2019-08-24T14:15:22Z",
  • "vbrRepositoryName": "string",
  • "vbrRestorePointCount": 0
}
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 Google Cloud configuration database.


SecurityBearer 
Request 
query Parameters
filter
string
Returns only specific items of a resource collection in the response. To learn how to use the filter parameter, see the Veeam Backup for Google Cloud REST API Reference, section Filter Parameter.


 
orderby
string
Specifies the order of items in the response. For more information, see the Veeam Backup for Google Cloud REST API Reference Overview, section Orderby Parameter.


 
offset
integer <int32> 
Specifies the first N items of a resource collection that will be excluded from the response.


 
limit
integer <int32> 
Specifies the maximum number of items of a resource collection that will be returned in the response.


 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud 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 at the server side.


get/api/v1/configurationBackup/restorePoints
Request samples 
Response samples 
application/json
{
  • "restorePoints": [
    ],
  • "pagination": {
    }
}
Get Configuration Backup Restore Point Data
The HTTP GET request to the /configurationBackup/restorePoints/{restorePointId} endpoint retrieves information on a restore point with the specified ID.


SecurityBearer 
Request 
path Parameters
restorePointId
required
string <uuid> 
Specifies the system ID assigned to a restore point in the Veeam Backup for Google Cloud REST API.


 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud 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 at the server side.


get/api/v1/configurationBackup/restorePoints/{restorePointId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "repositoryName": "string",
  • "size": 0,
  • "creationTimeUtc": "2019-08-24T14:15:22Z",
  • "jobType": "Scheduled"
}
Remove Configuration Backup Restore Point
The HTTP DELETE request to the /configurationBackup/restorePoints/{restorePointId} endpoint removes a specific restore point created for the Veeam Backup for Google Cloud configuration database.


SecurityBearer 
Request 
path Parameters
restorePointId
required
string <uuid> 
Specifies the system ID assigned to a restore point in the Veeam Backup for Google Cloud REST API.


 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud 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 at the server side.


delete/api/v1/configurationBackup/restorePoints/{restorePointId}
Request samples 
Response samples 
application/json
{
  • "sessionIds": [
    ],
  • "issues": [
    ]
}
Import Configuration Backup File
The HTTP POST request to the /configurationBackup/import endpoint allows you to upload a configuration backup file to the backup appliance.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud 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 at the server side.


post/api/v1/configurationBackup/import
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Start Configuration Backup Export
The HTTP POST request to the /configurationBackup/export endpoint launches the export operation for the configuration backup file from the latest restore point.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud REST API.


 
Request Body schema: application/json
required
password
required
string
Specifies a password that will be used to encrypt the file.


 
passwordHint
string
Specifies a hint for the password.


 
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 at the server side.


post/api/v1/configurationBackup/export
Request samples 
application/json
{
  • "password": "string",
  • "passwordHint": "string"
}
Response samples 
application/json
{
  • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}
Check Status of Configuration Backup Export
The HTTP POST request to the /configurationBackup/export/checkStatus endpoint allows to check whether the exported configuration backup file is ready for download.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud REST API.


 
Request Body schema: application/json
required
sessionId
required
string <uuid> 
Specifies the system ID assigned to the export session in the Veeam Backup for Google Cloud 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 at the server side.


post/api/v1/configurationBackup/export/checkStatus
Request samples 
application/json
{
  • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}
Response samples 
application/json
{
  • "isReadyToDownload": true
}
Download Configuration Backup File
The HTTP POST request to the /configurationBackup/export/downloadFile endpoint allows a user to download the exported configuration backup file.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud REST API.


 
Request Body schema: application/json
required
sessionId
required
string <uuid> 
System ID assigned to the export session in the Veeam Backup for Google Cloud 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 at the server side.


post/api/v1/configurationBackup/export/downloadFile
Request samples 
application/json
{
  • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}
Response samples 
"string"
Check Imported Backup File
The HTTP POST request to the /configurationBackup/import/{id}/check endpoint verifies whether the imported configuration backup file is not corrupted.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
System ID assigned to the configuration backup file in the Veeam Backup for Google Cloud REST API.


 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud REST API.


 
Request Body schema: application/json
required
backupFilePassword
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).


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 at the server side.


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

    
    

                                

                                    
Document updated 11/19/2025
Page content applies to build 7.0.0.47