Getting Backup Repositories
You can get a resource representation of a backup repository with the specified ID.
Request
GET https://<hostname>:4443/v6/BackupRepositories/{repositoryId} |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameter must be specified in the URL of the request:
Parameter | Type | Description |
---|---|---|
repositoryId | string | Specifies the identification number of the backup repository. For more information on how to get this parameter, see Getting Backup Repositories. |
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
In the response body, the server returns a resource representation of the /BackupRepositories/{repositoryId} resource. The response body contains the following properties:
Property | Type | Description |
---|---|---|
objectStorageId | string | Specifies the object storage ID. |
objectStorageCachePath | string | Specifies a path to the directory of the backup repository on a backup proxy server. |
objectStorageEncryptionEnabled | boolean | Defines whether the object storage encryption is enabled. |
encryptionKeyId | string | Specifies the encryption key ID. |
isOutOfSync | boolean | Defines whether a backup proxy server needs to be synchronized with the object storage to get the same cache state. |
capacityBytes | integer | Specifies the size of the backup repository in Bytes. |
freeSpaceBytes | integer | Specifies the available space on the backup repository in Bytes. |
id | string | Specifies the backup repository ID. |
name | string | Specifies a name of the backup repository. |
description | string | Specifies the backup repository description. |
path | string | Specifies a path to the directory where backups are stored. |
retentionType | string | Specifies the type of the retention policy. The following types are available:
|
retentionPeriodType | string | Specifies the retention period type. The following types are available:
|
retentionFrequencyType | string | Specifies clean-up schedule type. The following types are available:
|
dailyRetentionPeriod | integer | Specifies the retention period in days. This property is valid if retentionPeriodType is set to Daily. |
monthlyRetentionPeriod | integer | Specifies the retention period in months. This property is valid if retentionPeriodType is set to Monthly. |
yearlyRetentionPeriod | string | Specifies the retention period in years. The following values are available:
This property is valid if retentionPeriodType is set to Yearly. If set to Keep, the backup job will back up all selected items and will never remove them. |
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. The following values are available:
|
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. The following values are available:
|
monthlyDayofweek | string | For Monthly clean-up schedule. Specifies the day of the week when clean-up must be performed. The following values are available:
|
proxyId | string | Specifies the backup proxy ID. |
isLongTerm | boolean | Defines whether the backup repository is extended with an archive object storage. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The example returns a resource representation of the backup repository with the ID f93dc1b5-5ecd-45ce-b4dd-5519160b6713.
Request: GET https://abc.tech.local:4443/v6/BackupRepositories/f93dc1b5-5ecd-45ce-b4dd-5519160b6713
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "objectStorageId": "ffb0076b-b049-4034-aeb2-ec4d1ebc6fab", "objectStorageCachePath": "C:\\BackupArchiveRepo", "objectStorageEncryptionEnabled": false, "isOutOfSync": false, "capacityBytes": 138990841856, "freeSpaceBytes": 104829112320, "id": "f93dc1b5-5ecd-45ce-b4dd-5519160b6713", "name": "Backup Archive Repository", "description": "", "retentionType": "SnapshotBased", "retentionPeriodType": "Yearly", "yearlyRetentionPeriod": "Years3", "retentionFrequencyType": "Monthly", "monthlyTime": "23:00:00", "monthlyDaynumber": "First", "monthlyDayofweek": "Sunday", "proxyId": "89e8c35e-6c73-4f46-a37d-b365e513f7c6", "isLongTerm": true, "_links": { "self": { "href": "/v6/backuprepositories/f93dc1b5-5ecd-45ce-b4dd-5519160b6713" }, "proxy": { "href": "/v6/proxies/89e8c35e-6c73-4f46-a37d-b365e513f7c6" } } } |