Configure Retention Settings

You can configure global retention settings for Veeam Backup for Microsoft Azure.

Request

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

HTTP Request

PUT https://<hostname>/api/v2/settings/retention

Request Headers

The request contains the following headers.

Header

Required

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.

Request Body

To configure global retention settings use the RetentionSettingsV2 schema to send parameters in the request body. If you do not send a parameter, Veeam Backup for Microsoft Azure sets the default parameter value. The following parameters are required:

Parameter

Type

Description

duration

integer($int32)

Number of periods of time to keep snapshots or session records.

type

array[string]

Period of time: Days, Months, Years.

keepForever

boolean

Defines whether to keep all session records in the configuration database.

Set the parameter values in the following format:

{

 "sessionsSettings": {

   "duration": 0,

   "type": "Days",

   "keepForever": true

 },

 "obsoleteSnapshotsSettings": {

   "duration": 0,

   "type": "Days",

   "keepForever": true

 }

}

Response

The server returns the following response to the client.

Response Codes

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 Microsoft Azure returns new retention settings. The RetentionSettings schema is used for the collection representation.

Configure Retention SettingsExample

The following request configures retention settings for Veeam Backup for Microsoft Azure.

Request:

POST https://51.11.247.127/api/v2/settings/retention

Request Header:

Authorization: Bearer <Access-Token>

Content-Type: application/json

 

Request Body:

{

 "sessionsSettings": {

   "duration": 3,

   "type": "Days",

   "keepForever": true

 },

 "obsoleteSnapshotsSettings": {

   "duration": 20,

   "type": "Months",

   "keepForever": true

 }

}

 

Response:

200

 

Response Body:

{

 "sessionsSettings": {

   "duration": 3,

   "type": "Days",

   "keepForever": true

 },

 "obsoleteSnapshotsSettings": {

   "duration": 20,

   "type": "Months",

   "keepForever": true

 },

 "_links": {

   "self": {

     "href": "https://13.89.239.221/api/v2/settings/retention"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.