Get Auto-Backup Settings

You can get auto-backup settings configured in Veeam Backup for Microsoft Azure.

Request

To automatically create snapshots of the backup appliance, send the HTTP GET request to the /settings/autoBackup endpoint.

HTTP Request

GET https://<hostname>/api/v2/settings/autoBackup

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

Get Auto-Backup SettingsExample

The following request returns a full list of the configured auto-backup settings.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "generationsToSave": 7,

 "isEnabled": true,

 "schedule": {

   "_links": {},

   "frequencyType": "Daily",

   "dailyTime": "18:00:00",

   "dailyType": "Everyday"

 },

 "_links": {

   "self": {

     "href": "https://51.11.247.127/api/v2/settings/autoBackup"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

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