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

Get Veeam Availability Console License Usage

You can get a representation of the information about company backup agents managed by Veeam Availability Console, and number of instances they consume.


To get a representation of instances consumed by company backup agents, send the GET HTTPS request to the URL of the /tenants/{ID}/licensing/availabilityConsoleUsage resource.

HTTP Request

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

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/availabilityConsoleUsage resource.

Example Get Veeam Availability Console License Usage

The following request returns information about instances consumed by backup agents of a company with ID 2.


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


Request Header:

Authorization: Bearer <Access-Token>


Response Code:

200 Success


Response Body:



   "type": "VAC_Windows_Server_Agent",

   "rentalInstances": 0,

   "newInstances": 0.66,

   "usedInstances": 3.3,

   "rentalCount": 0,

   "newCount": 2,

   "usedCount": 10



   "type": "VAC_Windows_Workstation_Agent",

   "rentalInstances": 0,

   "newInstances": 1.6,

   "usedInstances": 16,

   "rentalCount": 0,

   "newCount": 10,

   "usedCount": 100



Veeam Large Logo

Deployment Guide

Guide for Service Providers

Guide for End Users

Guide for Resellers

Usage Scenarios for Service Providers

RESTful API Reference