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

Get Veeam Backup & Replication License Usage

You can get a representation of license usage information from managed Veeam Backup & Replication servers of a specific company.


To get a representation of instances used to protect company workloads, send the GET HTTPS request to the URL of the /tenants/{ID}/licensing/backupServerUsage resource.

HTTP Request

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

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}/licensing/backupServerUsage resource.

Example Get Veeam Backup & Replication License Usage

The following request returns information about consumed instances from Veeam Backup & Replication servers of a company with ID 2.


GET https://localhost:1281/v2/tenants/2/licensing/backupServerUsage


Request Header:

Authorization: Bearer <Access-Token>


Response Code:

200 Success


Response Body:



   "type": "VBR_vSphere_VM",

   "rentalInstances": 0,

   "newInstances": 1,

   "usedInstances": 34,

   "rentalCount": 0,

   "newCount": 1,

   "usedCount": 34



   "type": "VBR_Windows_Server_Agent",

   "rentalInstances": 0,

   "newInstances": 0,

   "usedInstances": 1,

   "rentalCount": 0,

   "newCount": 0,

   "usedCount": 1



   "type": "VBR_Windows_Workstation_Agent",

   "rentalInstances": 0,

   "newInstances": 0.33,

   "usedInstances": 0,

   "rentalCount": 0,

   "newCount": 1,

   "usedCount": 0



Veeam Large Logo

Deployment Guide

Guide for Service Providers

Guide for End Users

Guide for Resellers

Usage Scenarios for Service Providers

RESTful API Reference