This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Backup Repositories

This section explains how to get a list of backup repositories.

Request

GET https://<hostname>/api/v1/repositories

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

None.

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
offset	integer	Shows the offset value.
limit	integer	Shows the offset limit.
totalCount	integer	Shows the number of records in the results array.
results	Results Object	Contains the result object.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

Results Object

Property	Type	Description
id	integer	Shows the identification number of the backup repository.
name	string	Shows the name of the backup repository.
description	string	Shows the description of the backup repository.
azureStorageAccountId	string	Shows the identification number of the Azure storage account.
azureStorageAccountName	string	Shows the name of the Azure storage account.
azureStorageFolder	AzureStorageItem Object	Shows the name of the folder that is used as a backup repository.
azureStorageContainer	AzureStorageItem Object	Shows the name of the container that contains the repository folder.
enableEncryption	boolean	Shows if the encryption is enabled.
hint	string	Shows the password hint.
regionId	string	Shows the identification number of the Azure region.
regionName	string	Shows the name of the Azure region.
azureConnectionId	integer	Shows the identification number of the Azure connection.
environment	string	Shows the Azure environment.
status	string	Shows the status of the backup repository.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

AzureStorageItem Object

Property	Type	Description
name	string	Shows the name of the Azure container or folder.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

Example

Request:

GET https://abc.ukwest.cloudapp.azure.com/api/v1/repositories

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"offset": 0,

"limit": 30,

"totalCount": 1,

"results": [ {

"id": 2,

"name": "Backup Repository",

"description": "",

"azureStorageAccountId": "6s9rdnmvdsnmebudp49abg8gg44k3t4huhka9anrca1smd9u8wwo",

"azureStorageAccountName": "twstorageaccounttim",

"azureStorageFolder": {

"name": "OSRv1",

"_links": {}

"azureStorageContainer": {

"name": "container2",

"_links": {}

"enableEncryption": true,

"hint": "123",

"regionId": "westeurope",

"regionName": "westeurope",

"azureConnectionId": 9,

"environment": "Global",

"status": "Ready",

"_links": {}

}],

"_links": {"self": {"href": "https://abc.ukwest.cloudapp.azure.com:443/api/v1/repositories?offset=0&limit=30"}}

}