Help Center
Choose product document...
Veeam Availability Console 3.0
RESTful API Reference

Get a Company Backup Resource

You can get a representation of a company backup resource with the specified ID.


To get a representation of a company backup resource in Veeam Availability Console, send the GET HTTPS request to the URL of the /tenants/{ID}/backupResources/{ID} resource.

HTTP Request

GET https://<Availability-Console>:1281/v2/tenants/{ID}/backupResources/{ID}

Request Headers

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


The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 200 Success.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.




The length of the response body.


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

Response Body

In the response body, Veeam Availability Console returns a representation of the /tenants/{ID}/backupResources/{ID} resource.

Example Get a Company Backup Resource

The following example returns a representation of a backup resource with ID 1 configured for a company with ID 2.


GET https://localhost:1281/v2/tenants/2/backupResources/1


Request Header:

Authorization: Bearer <Access-Token>


Response Code:

200 Success


Response Body:


   "id": 1,

   "cloudRepositoryName": "Delta Cloud Vol01",

   "providerRepositoryUid": "1ca14917-1b46-422d-b536-4baba4fe92db",

   "storageQuota": 300,

   "storageQuotaUnits": "GB",

   "vMsQuota": 0,

   "quotasAreUnlimited": false,

   "serversQuota": 3,

   "workstationsQuota": 3,

   "trafficQuota": 0,

   "trafficQuotaUnits": "GB",

   "wanAccelerationEnabled": true,

   "usedStorageQuota": 10.6,

   "usedStorageQuotaUnits": "GB",

   "usedTrafficQuota": 1.9,

   "usedTrafficQuotaUnits": "MB",

   "intervalStartTime": "2019-03-22T00:00:00Z",

   "intervalEndTime": "2019-03-28T00:00:00Z",

   "_links": {

     "self": {

       "href": ""


     "backupRepositories": {

       "href": ""


     "wanAccelerators": {

       "href": ""




Veeam Large Logo

Deployment Guide

Guide for Service Providers

Guide for End Users

Guide for Resellers

Usage Scenarios for Service Providers

RESTful API Reference