Adds backup repositories to Veeam Backup for Microsoft Office 365.
You can set the retention period for a backup repository in years, months or days. Backup jobs targeted to this repository will back up organization items that were created or modified within the indicated retention period. For example, if you set the retention period to 11 months, the backup job will back up all items that were created or modified 11 months ago or later. When an item’s age exceeds the retention, it is deleted.
Additionally, you can configure a clean-up schedule to check the backups in the repository and remove the outdated ones. Depending on how frequently you want to perform a clean-up you can set a daily or monthly schedule. For each clean-up schedule type, you can specify the clean-up day and time.
Request
To create a backup repository, send the POST HTTPS request to the URL of the /BackupRepositories resource.
HTTPS Request
POST https://<Backup-Office365>:4443/v2/BackupRepositories |
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
Content-Type: application/json | true | Specifies the type of the content for your request. |
Authorization: Bearer <Access-Token> | true | The request header must contain the authorization token for the current logon session. |
Request Body
The request body must contain the following properties:
Property | Type | Description |
Name | string | Specifies the name of the backup repository. For example, "name": "ABC Support". |
ProxyId | string | Specifies the ID of a backup proxy. Veeam Backup for Microsoft Office 365 will add backup repository to this proxy. For example, "proxyId": "5a905bb5-9071-433c-9d2f-f805d4da2cf4". |
Path | string | Specifies the full path to the folder where the backups will be stored. The destination folder must be created before making the request. For example, "path": "C:\\ABC_support". |
Description | string | Specifies the description of the backup repository. For example, "description": "Daily". |
Retention | string | Specifies the retention period type:
For example, "retentionPeriodType": "Daily". |
Daily | string | Specifies the retention period in days. This property is valid if retentionPeriodType is set to Daily. For example, "dailyRetentionPeriod": "14". |
Monthly | string | Specifies the retention period in months. This property is valid if retentionPeriodType is set to Monthly. For example, "monthlyRetentionPeriod": "6". |
Yearly | string | Specifies the retention period in years:
This property is valid if retentionPeriodType is set to Yearly. If you select KeepForever, the backup job will back up all selected items and will never remove them. For example, "yearlyRetentionPeriod": "KeepForever". |
Retention | string | Specifies clean-up schedule type:
For example, "retentionFrequencyType": "Monthly". |
DailyTime | UTC | For daily clean-up schedule. Specifies the time of the day when clean-up must be performed. For example, "dailyTime": "08:00:00". |
DailyType | string | For daily clean-up schedule. Specifies the days when clean-up must be performed:
For example, "dailyType": "Workdays". |
MonthlyTime | UTC | For monthly clean-up schedule. Specifies the time of the day when clean-up must be performed. For example, "monthlyTime": "00:00:00". |
Monthly | string | For monthly clean-up schedule. Specifies the order number for the day of the week when clean-up must be performed:
For example, "monthlyDayNumber": "Last". |
Monthly | string | For monthly clean-up schedule. Specifies the day of the week when clean-up must be performed:
For example, "monthlyDayOfWeek": "Sunday". |
Attach | bool | Adds a backup repository that was associated with a different backup proxy. If set to True, Veeam Backup for Microsoft Office 365 will assign a backup repository with backups to the backup proxy with a specified ID and add it to the backup infrastructure. For example, "attachUsedRepository": "true". |
For example:
{ "name": "ABC Support", "proxyId": "5a905bb5-9071-433c-9d2f-f805d4da2cf4", "retentionPeriodType": "Daily", "dailyRetentionPeriod": 14, "retentionFrequencyType": "Daily", "dailyTime": "08:00:00", "description": "", "dailyType": "Weekends", "path": "C:\\ABC_Support", "attachUsedRepository": "true" } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 201 Created.
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 request body message: application/json; charset=utf-8 |
Response Body
In the response body, the server returns a representation of a backup repository resource. The resource has the following URL: /BackupRepositories/{ID}.
Example
The example below shows how to create a backup repository on a backup proxy.
Request: POST https://support.east.local:4443/v2/BackupRepositories
Request Header: Content-Type: application/json Authorization: Bearer <Access-Token>
Request Body:
{ "name": "ABC Support", "proxyId": "5a905bb5-9071-433c-9d2f-f805d4da2cf4", "retentionPeriodType": "Daily", "dailyRetentionPeriod": 14, "retentionFrequencyType": "Daily", "dailyTime": "08:00:00", "description": "", "dailyType": "Weekends", "path": "C:\\ABC_support", "attachUsedRepository": "true" }
Response: 201 Created
Response Body: { "id": "5729d9cf-abfa-4077-9dd5-f5a888b98147", "name": "ABC Support", "proxyId": "5a905bb5-9071-433c-9d2f-f805d4da2cf4", "retentionPeriodType": "Daily", "dailyRetentionPeriod": 14, "retentionFrequencyType": "Daily", "dailyTime": "08:00:00", "description": "Daily", "dailyType": "Weekends", "path": "C:\\ABC_support", "capacity": 128479916032, "freeSpace": 111512092672, "_links": { "self": { "href": "https://support.east.local:4443/v2/BackupRepositories/5729d9cf-abfa-4077-9dd5-f5a888b98147" }, "proxy": { "href": "https://support.east.local:4443/v2/Proxies/5a905bb5-9071-433c-9d2f-f805d4da2cf4" } } } |
