Retention Settings

The /settings/retention resource collection represents global retention settings configured in Veeam Backup for Microsoft Azure.

Get Global Retention Settings

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

SecurityBearer
Responses
200

OK

401

Unauthorized

403

Forbidden

get/api/v8/settings/retention
Request samples
curl -i -X GET \
  https://123.123.123.123/api/v8/settings/retention \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "sessionsSettings": {
    },
  • "obsoleteSnapshotsSettings": {
    },
  • "_links": {}
}

Modify Global Retention Settings

The HTTP PUT request to the /settings/retention endpoint allows you to configure and modify global retention settings in Veeam Backup for Microsoft Azure.

SecurityBearer
Request
Request Body schema: application/json
required
required
object (RetentionSetting)

Global retention settings for keeping session records (for sessionsSettings, the minimum possible value is 1 day) or snapshots of unprotected Azure VMs (for obsoleteSnapshotsSettings, the minimum possible value is 15 days).

required
object (RetentionSetting)

Global retention settings for keeping session records (for sessionsSettings, the minimum possible value is 1 day) or snapshots of unprotected Azure VMs (for obsoleteSnapshotsSettings, the minimum possible value is 15 days).

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

put/api/v8/settings/retention
Request samples
application/json
{
  • "sessionsSettings": {
    },
  • "obsoleteSnapshotsSettings": {
    }
}
Response samples
application/json
{
  • "sessionsSettings": {
    },
  • "obsoleteSnapshotsSettings": {
    },
  • "_links": {}
}