Get Veeam Service Provider Console License Usage

In this article

    You can get a representation of the information about company backup agents managed by Veeam Service Provider 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://<hostname>:1281/v2/tenants/{ID}/licensing/availabilityConsoleUsage

    Request Headers

    The request header must contain the authorization token.


    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.




    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 Service Provider Console returns a representation of the /tenants/{ID}/licensing/availabilityConsoleUsage resource.

    Example Get Veeam Service Provider 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_Server_Agent",

       "unitType": "Instances"

       "rentalUnits": 0,

       "newUnits": 0.66,

       "usedUnits": 3.3,

       "rentalCount": 0,

       "newCount": 2,

       "usedCount": 10



       "type": "VAC_Workstation_Agent",

       "unitType": "Instances"

       "rentalUnits": 0,

       "newUnits": 1.6,

       "usedUnits": 16,

       "rentalCount": 0,

       "newCount": 10,

       "usedCount": 100