This is an archive version of the document. To get the most up-to-date information, see the current version.Getting Auto-Backup Settings
This section explains how to get auto-backup settings.
Request
GET https://<hostname>/api/v1/settings/autoBackup |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
None.
Request Body
None.
Responses
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 HTTPS headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body for Daily at this time Option
Property | Type | Description |
|---|---|---|
generationsToSave | integer | Shows the number of the snapshots to keep. |
isEnabled | boolean | Shows if the auto-backup functionality is enabled. |
schedule | Contains the Schedule object. | |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Schedule Object for Daily at this time Option
Property | Type | Description |
|---|---|---|
id | integer | Shows the identification number of the assigned schedule. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
frequencyType | string | Shows the frequency of how often an auto-backup must be performed. Possible values:
|
dailyTime | string | Shows at what time an auto-backup must be performed. |
dailyType | string | Shows on which day an auto-backup must be performed. Possible values:
|
Example of Response Body for Daily at this time Option
Request: GET https://abc.ukwest.cloudapp.azure.com/api/v1/settings/autoBackup
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "generationsToSave": 7, "isEnabled": true, "schedule": { "id": 1, "_links": {}, "frequencyType": "Daily", "dailyTime": "20:00:00", "dailyType": "Everyday" }, "_links": {"self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/settings/autoBackup"}} } |
Response Body for Monthly at this time Option
Property | Type | Description |
|---|---|---|
generationsToSave | integer | Shows the number of the snapshots to keep. |
isEnabled | boolean | Shows if the auto-backup functionality is enabled. |
schedule | Contains the Schedule object. | |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Schedule Object for Monthly at this time Option
Property | Type | Description |
|---|---|---|
id | integer | Shows the identification number of the assigned schedule. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
frequencyType | string | Shows the frequency of how often an auto-backup must be performed. Possible values:
|
monthlyTime | string | Shows at what time an auto-backup must be performed. |
monthlyType | string | Shows when to perform an auto-backup. Possible values:
|
monthlyDayOfWeek | string | Shows the day on which an auto-backup session must be initiated. |
selectedMonths | string | Shows on which months to create an auto-backup. |
Example of Response Body for Monthly at this time Option
Request: GET https://abc.ukwest.cloudapp.azure.com/api/v1/settings/autoBackup
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "generationsToSave": 7, "isEnabled": true, "schedule": { "id": 1, "_links": {}, "frequencyType": "Monthly", "monthlyTime": "20:00:00", "monthlyType": "First", "monthlyDayOfWeek": "Monday", "selectedMonths": [ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ] }, "_links": {"self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/settings/autoBackup"}} } |
Response Body for Periodically every Option
Property | Type | Description |
|---|---|---|
generationsToSave | integer | Shows the number of the snapshots to keep. |
isEnabled | boolean | Shows if the auto-backup functionality is enabled. |
schedule | Contains the Schedule object. | |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Schedule Object for Periodically every Option
Property | Type | Description |
|---|---|---|
id | integer | Shows the identification number of the assigned schedule. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
frequencyType | string | Shows the frequency of how often an auto-backup must be performed. Possible values:
|
periodicallyType | string | Shows the unit for periodic backups. Possible values:
|
interval | string | Shows the interval for the specified unit. |
periodicalScheduleWindow | string | Shows the window with allowed and prohibited hours. |
minuteOffset | integer | Shows the offset. |
Example of Response Body for Periodically every Option
Request: GET https://abc.ukwest.cloudapp.azure.com/api/v1/settings/autoBackup
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "generationsToSave": 7, "isEnabled": true, "schedule": { "id": 1, "_links": {}, "frequencyType": "Periodically", "periodicallyType": "Hours", "interval": 1, "periodicalScheduleWindow": { "window": { "Sunday": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 0 ], "Monday": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23 ], "Tuesday": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23 ], "Wednesday": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23 ], "Thursday": [ 0, 1, 2, 3, 4, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23 ], "Friday": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23 ], "Saturday": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23 ] }, "minuteOffset": 0 } }, "_links": {"self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/settings/autoBackup"}} } |