This section explains how to get a resource representation of a backup repository with the specified ID.
Request
GET https://<hostname>:4443/v4/BackupRepositories/{repositoryId} |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be posted as URL.
Parameter | Type | Description |
repositoryId | string | An identification number of the backup repository. |
Request Body
None.
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 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
Property | Type | Description |
|---|---|---|
Id | string | Specifies the ID of the backup repository. |
Name | string | Specifies the name of the backup repository. |
ProxyId | string | Specifies the ID of a backup proxy. Veeam Backup for Microsoft Office 365 will create a backup repository on this proxy. |
Path | string | Specifies the full path to the folder where the backups will be stored. |
Description | string | Specifies the description of the backup repository. |
RetentionType | retentionType | Specifies the type of the retention policy:
|
RetentionPeriodType | string | Specifies the retention period type:
|
DailyRetentionPeriod | string | Specifies the retention period in days. This property is valid if retentionPeriodType is set to Daily. |
MonthlyRetentionPeriod | string | Specifies the retention period in months. This property is valid if retentionPeriodType is set to Monthly. |
YearlyRetentionPeriod | 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. |
RetentionFrequencyType | string | Specifies clean-up schedule type:
|
DailyTime | UTC | For daily clean-up schedule. Specifies the time of the day when clean-up must be performed. |
DailyType | string | For daily clean-up schedule. Specifies the days when clean-up must be performed:
|
MonthlyTime | UTC | For monthly clean-up schedule. Specifies the time of the day when clean-up must be performed. |
MonthlyDayNumber | string | For monthly clean-up schedule. Specifies the order number for the day of the week when clean-up must be performed:
|
MonthlyDayOfWeek | string | For monthly clean-up schedule. Specifies the day of the week when clean-up must be performed:
|
CapacityBytes | int | Capacity of a backup repository. |
FreeSpaceBytes | int | Free space remaining on a backup repository. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The following request returns a representation of a backup repository with the ID 5729d9cf-abfa-4077-9dd5-f5a888b98147.
Request: GET https://abc.tech.local:4443/v4/BackupRepositories/5729d9cf-abfa-4077-9dd5-f5a888b98147
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
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", "retentionType": "ItemLevel", "dailyType": "Weekends", "path": "C:\\ABC_support", "capacityBytes": 128479916032, "freeSpaceBytes": 111512793088, "_links": { "self": { "href": "https://abc.tech.local:4443/v4/BackupRepositories/22318b1b-3249-48b3-b340-61b783c1222c" }, "proxy": { "href": "https://abc.tech.local:4443/v4/Proxies/817e8616-27c3-46db-a18c-1da0b29e6e5a" } } } |
