Get Veeam Service Provider Console License Usage

In this article

    You can get a representation of the information about tenant backup agents managed by Veeam Service Provider Console, and number of license units they use.


    To get a representation of license units used by tenant backup agents, send the GET HTTPS request to the URL of the /tenants/{instanceUid}/licensing/availabilityConsoleUsage/byVCCTenantUid resource.

    HTTP Request

    GET https://<hostname>:1281/v2/tenants/{instanceUid}/licensing/availabilityConsoleUsage/byVCCTenantUid

    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/{instanceUid}/licensing/availabilityConsoleUsage/byVCCTenantUid resource.

    Example Get Veeam Service Provider Console License Usage

    The following request returns information about license units used by backup agents of a tenant with ID 912d0e66-4a1e-4bfe-9556-0b2c7fb95a17.


    GET https://localhost:1281/v2/tenants/912d0e66-4a1e-4bfe-9556-0b2c7fb95a17/licensing/availabilityConsoleUsage/byVCCTenantUid


    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