Get Global Retention Settings

You can get global retention settings configured in Veeam Backup for Microsoft Azure.

Request

To retrieve a list of retention settings, send the HTTP GET request to the /settings/retention endpoint.

HTTP Request

GET 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.

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 retention settings configured in Veeam Backup for Microsoft Azure. The RetentionSettingsV2 schema is used for the collection representation.

Get Global Retention SettingsExample

The following request returns a full list of configured global retention settings.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "sessionsSettings": {

   "duration": 365,

   "type": "Days",

   "keepForever": false

 },

 "obsoleteSnapshotsSettings": {

   "duration": 365,

   "type": "Days",

   "keepForever": false

 },

 "_links": {

   "self": {

     "href": "https://51.11.247.127/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.