Get Collection of Repositories

You can get a list of all repositories added to the Veeam Backup for Microsoft Azure configuration database.

Request

To retrieve a representation of a collection of  repositories, send the HTTP GET request to the /repositories endpoint.

HTTP Request

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

Query Parameters

To control the amount and order of data in the response, you can use Offset, Limit, SearchPattern and the following query parameters:

Query Parameter

Value

Description

Status

  • Creating
  • Importing
  • Ready
  • Failed

Returns only repositories with the specified status. For more information, see Filter Parameters.

Request Headers

The request contains the following headers.

Header

Required

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

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 HTTP headers.

Header

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns a representation of the /repositories collection. The RepositoryV2 schema is used for the collection representation.

Get Collection of RepositoriesExample

The following request returns a full list of repositories added to the Veeam Backup for Microsoft Azure configuration database.

Request:

GET https://51.11.247.127/api/v2/repositories

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "offset": 0,

 "limit": 200,

 "totalCount": 1,

 "results": [

   {

     "id": "1",

     "name": "Repository",

     "description": "Created by Default Admin",

     "azureStorageAccountId": "k1iwcetykpfn6r457qdsrpedsbj9yj5ibiqxapn9sgr1zy5qsa3y",

     "azureStorageAccountName": "cpmStorageAcc",

     "azureStorageFolder": {

       "name": "backup",

       "_links": {}

     },

     "azureStorageContainer": {

       "name": "backup",

       "_links": {}

     },

     "enableEncryption": false,

     "regionId": "ukwest",

     "regionName": "ukwest",

     "azureAccountId": "1",

     "environment": "Global",

     "status": "Ready",

     "storageTier": "Hot",

     "usn": 69,

     "_links": {

       "self": {

         "href": "https://51.11.247.127/api/v2/repositories/1"

       }

     }

   }

 ],

 "_links": {

   "self": {

     "href": "https://51.11.247.127/api/v2/repositories?offset=0&limit=200"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.