This is an archive version of the document. To get the most up-to-date information, see the current version.

Reset Global Retention Settings

You can reset global retention settings configured in Veeam Backup for AWS to default values.

Request

To reset the retention settings, send the HTTP POST request to the /settings/retentionSettings/reset endpoint.

HTTP Request

POST https://<hostname>:<port>/api/v1/settings/retentionSettings/reset

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.

Accept

Optional

  • application/json
  • application/problem+json

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.

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

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for AWS returns the default retention settings. The RetentionSettings schema is used for the collection representation.

Reset Global Retention SettingsExample

The following request resets global retention settings configured in Veeam Backup for AWS.

Request:

POST https://135.169.170.192:11005/api/v1/settings/retentionSettings/reset

 

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

 

Response:

200

 

Response Body:

{

 "lingeringSnapshotRetentionDisabled": true,

 "lingeringSnapshotRetention": {

   "retentionDurationType": "Points",

   "timeRetentionDuration": 365

 },

 "sessionsRetention": {

   "retentionDurationType": "Daily",

   "timeRetentionDuration": 365

 },

 "keepAllSessions": false,

 "_links": [

   {

     "method": "GET",

     "rel": "self",

     "href": "https://135.169.170.192:11005/api/v1/settings/retentionSettings"

   },

   {

     "method": "POST",

     "rel": "update",

     "href": "https://135.169.170.192:11005/api/v1/settings/retentionSettings"

   },

   {

     "method": "POST",

     "rel": "Reset",

     "href": "https://135.169.170.192:11005/api/v1/settings/retentionSettings/reset"

   }

 ]

}