Veeam Backup for Google Cloud 7
REST API Reference
Related documents

General Settings

The /configuration resource collection represents global retention and notification settings configured in Veeam Backup for Google Cloud.

Get Global Retention Settings

The HTTP GET request to the /configuration/retention endpoint retrieves global retention settings configured in Veeam Backup for Google Cloud.

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.

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/configuration/retention
Request samples 
Response samples 
application/json
{
  • "lingeringSnapshotRetentionDisabled": true,
  • "lingeringSnapshotRetention": {
    },
  • "defaultSnapshotRetention": 0,
  • "sessionsRetention": {
    },
  • "keepAllSessions": true
}
Configure Global Retention Settings
The HTTP POST request to the /configuration/retention endpoint specifies global retention settings for Veeam Backup for Google Cloud.


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
lingeringSnapshotRetentionDisabled
required
boolean
Defines whether to keep snapshots of VM instances that are no longer protected. By default, Veeam Backup for Google Cloud does not remove snapshots for instances that are no longer processed by a backup policy.


 
keepAllSessions
required
boolean
Defines whether to keep all session records in the configuration database. Veeam Backup for Google Cloud removes session records from the database after 90 days.


 
defaultSnapshotRetention
required
integer <int32>   >= 0 
Default number of snapshots to keep.


 
required
object (PeriodicRetentionOptionsModel) 
Number of days or months to keep session records or snapshots of unprotected instances. The minimum possible value for snapshots — 90 days or 3 months, for session records — 1 day.


 
object (PeriodicRetentionOptionsModel) 
Number of days or months to keep session records or snapshots of unprotected instances. The minimum possible value for snapshots — 90 days or 3 months, for session records — 1 day.


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


post/api/v1/configuration/retention
Request samples 
application/json
{
  • "lingeringSnapshotRetentionDisabled": true,
  • "lingeringSnapshotRetention": {
    },
  • "defaultSnapshotRetention": 0,
  • "sessionsRetention": {
    },
  • "keepAllSessions": true
}
Response samples 
application/json
{
  • "retentionSettings": {
    },
  • "issues": [
    ]
}
Reset Global Retention Settings
The HTTP POST request to the /configuration/retention/resetToDefault endpoint resets global retention settings configured in Veeam Backup for Google Cloud to default values.


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.


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.


post/api/v1/configuration/retention/resetToDefault
Request samples 
Response samples 
application/json
{
  • "retentionSettings": {
    },
  • "issues": [
    ]
}

    
    

                                

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