Get Backup Repositories

In this article

    You can get a representation of a collection of repositories configured on the Veeam Cloud Connect server and tenant Veeam Backup & Replication servers. The collection includes simple backup repositories, scale-out backup repositories and cloud repositories available to tenants.

    Request

    To get a representation of all backup repositories configured on the service provider and tenant backup servers, send the GET HTTPS request to the URL of the /backupRepositories collection.

    HTTPS Request

    GET https://<hostname>:1281/v2/backupRepositories

    Request Headers

    The request header must contain the authorization token for the current logon session.

    Response

    The server returns the following response to the client.

    Response Code

    A successfully completed operation returns 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

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the request body message: application/json; charset=utf-8

    Response Body

    In the response body, Veeam Service Provider Console returns a representation of the /backupRepositories collection.

    Example Get Backup Repositories

    The following request returns a representation of all repositories displayed in Veeam Service Provider Console.

    Request:

    GET https://localhost:1281/v2/backupRepositories

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response Code:

    200 Success

     

    Response Body:

    [

     {

       "id": 7,

       "name": "Default Backup Repository",

       "repositoryUid": "8c67a7dc-ef78-4df9-bde3-facdfa6b9b5c",

       "serverName": "BACKUP01",

       "companyName": "Alpha",

       "locationName": "Default location",

       "capacity": 119.7,

       "capacityUnits": "GB",

       "freeSpace": 86.1,

       "freeSpaceUnits": "GB",

       "backupSize": 11.5,

       "backupSizeUnits": "GB",

       "healthState": "OK",

       "backupServerId": 3,

       "isServiceProviderRepository": true,

       "_links": {

         "self": {

           "href": "https://vac.tech.local:1281/v2/backupRepositories/7"

         },

         "backupServers": {

           "href": "https://vac.tech.local:1281/v2/backupServers/3"

         },

         "tenants": {

           "href": "https://vac.tech.local:1281/v2/tenants/3"

         },

         "locations": {

           "href": "https://vac.tech.local:1281/v2/tenants/3/locations/3"

         }

       }

     },

     {

       "id": 3,

       "name": "Default Backup Repository",

       "repositoryUid": "a1463bc2-9dfe-4c02-b053-51725a730f73",

       "serverName": "BACKUP02",

       "companyName": "Delta",

       "locationName": "Main Office",

       "capacity": 119.7,

       "capacityUnits": "GB",

       "freeSpace": 98.8,

       "freeSpaceUnits": "GB",

       "backupSize": 211.1,

       "backupSizeUnits": "MB",

       "healthState": "OK",

       "backupServerId": 2,

       "isServiceProviderRepository": true,

       "_links": {

         "self": {

           "href": "https://vac.tech.local:1281/v2/backupRepositories/3"

         },

         "backupServers": {

           "href": "https://vac.tech.local:1281/v2/backupServers/2"

         },

         "tenants": {

           "href": "https://vac.tech.local:1281/v2/tenants/2"

         },

         "locations": {

           "href": "https://vac.tech.local:1281/v2/tenants/2/locations/2"

         }

       }

     }

    ]