Configure Auto-Backup Settings
You can configure auto-backup settings for Veeam Backup for Microsoft Azure.
Request
To configure auto-backup settings, send the HTTP PUT request to the /settings/autoBackup endpoint.
Note |
To configure or update auto-backup settings, you must enable auto-backup as described in section Enable Auto-Backup. |
HTTP Request
PUT 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. |
Request Body
To configure auto-backup settings use the AutoBackupV2 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:
Set the parameter values in the following format:
{ "generationsToSave": 0, "isEnabled": true, "schedule": { "frequencyType": "Daily", "dailyTime": "string", "dailyType": "Everyday", "selectedDays": [ "Sunday" ], "monthlyTime": "string", "monthlyType": "First", "monthlyDayOfWeek": "Sunday", "monthlyDay": 0, "monthlyLastDay": true, "selectedMonths": [ "January" ], "periodicallyType": "Minutes", "interval": 0, "periodicalScheduleWindow": { "window": { "Sunday": [ 0 ], "Monday": [ 0 ], "Tuesday": [ 0 ], "Wednesday": [ 0 ], "Thursday": [ 0 ], "Friday": [ 0 ], "Saturday": [ 0 ] }, "minuteOffset": 0 } } } |
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 |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for Microsoft Azure returns new auto-backup settings. The AutoBackupV2 schema is used for the collection representation.
Example
The following request modifies auto-backup settings for Veeam Backup for Microsoft Azure.
|