This is an archive version of the document. To get the most up-to-date information, see the current version.Configure Global Retention Settings
You can configure global retention settings for Veeam Backup for AWS.
Request
To configure retention settings, send the HTTP POST request to the /settings/retentionSettings endpoint.
HTTP Request
POST https://<hostname>:<port>/api/v1/settings/retentionSettings |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
|---|---|---|---|
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
x-api-version | Required | 1.0-rev0 | Specifies the current revision of the Veeam Backup for AWS REST API. |
Content-Type | Required | application/json | Identifies a media type that is used in the body of the request. |
Accept | Optional |
| Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request Body
To configure global retention settings use the RetentionSettings schema to send parameters in the request body. If you do not send a parameter, Veeam Backup for AWS sets the default parameter value. The following parameters are required:
Parameter | Type | Description |
|---|---|---|
lingeringSnapshotRetentionDisabled | boolean | Defines whether to keep snapshots of unprotected EC2 instances. |
keepAllSessions | string | Defines whether to keep all session records in the configuration database. |
Set the parameter values in the following format:
{ "lingeringSnapshotRetentionDisabled": true/false, "lingeringSnapshotRetention": { "timeRetentionDuration": integer, "retentionDurationType": "Daily/Monthly" }, "sessionsRetention": { "timeRetentionDuration": integer, "retentionDurationType": "Daily/Monthly" }, "keepAllSessions": true/false } |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Value | Description |
|---|---|---|
Content-Length | integer | Identifies the length of the response body message, in bytes. |
Content-Type |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for AWS returns new retention settings. The RetentionSettings schema is used for the collection representation.
Example
The following request configures retention settings for Veeam Backup for AWS.
|