Veeam Backup for AWS 9
REST API Reference
Related documents

Global Retention Settings

The /retentionSettings resource collection represents global retention settings configured in Veeam Backup for AWS.

Get Global Retention Settings

The HTTP GET request to the /settings/retentionSettings endpoint retrieves global retention settings configured in Veeam Backup for AWS.

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/settings/retentionSettings
Request samples 
curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/settings/retentionSettings \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{}

Configure Global Retention Settings

The HTTP POST request to the /settings/retentionSettings endpoint specifies global retention settings for Veeam Backup for AWS.

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
lingeringSnapshotRetentionDisabled
required
boolean

Defines whether to keep snapshots of instances that are no longer protected. The default value is true: Veeam Backup for AWS do not remove EBS 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. The default value is false: Veeam Backup for AWS removes session records from the database after 3 months.

object (RetentionSetting)

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 (RetentionSetting)

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.

Array of objects (Link)

A list of methods and operations available to the /retentionSettings resource collection, and request URLs used to perform the operations.

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

post/api/v1/settings/retentionSettings
Request samples
application/json
{
  • "lingeringSnapshotRetentionDisabled": true,
  • "lingeringSnapshotRetention": {
    },
  • "sessionsRetention": {
    },
  • "keepAllSessions": false
}
Response samples
{}

Reset Global Retention Settings

The HTTP POST request to the /settings/retentionSettings/reset endpoint resets global retention settings configured in Veeam Backup for AWS to default values.

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

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