Get Repository Data

You can get data on a repository with the specified ID.

Request

To retrieve information on a specific repository, send the HTTP GET request to the /repositories/{repositoryId} endpoint. {repositoryId} is a system ID assigned to the repository in the Veeam Backup for Microsoft Azure REST API.

HTTP Request

GET https://<hostname>/api/v2/repositories/{repositoryId}

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 repository with the specified ID. The RepositoryV2 schema is used for the resource representation.

Get Repository DataExample

The following request returns information on a repository with the ID 34ea638c-242f-4c8f-8015-f6f7824cbdc3.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "id": "2",

 "name": "Added Rep",

 "description": "none",

 "azureStorageAccountId": "k1iwcetykpfn6r457qdsrpedsbj9yj5ibiqxapn9sgr1zy5qsa3y",

 "azureStorageAccountName": "cpmbackupluaanukwest",

 "azureStorageFolder": {

   "name": "new folder",

   "_links": {}

 },

 "azureStorageContainer": {

   "name": "backup",

   "_links": {}

 },

 "enableEncryption": false,

 "regionId": "ukwest",

 "regionName": "ukwest",

 "azureAccountId": "1",

 "environment": "Global",

 "status": "Ready",

 "storageTier": "Cool",

 "usn": 269,

 "_links": {

   "self": {

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

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

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