Get Veeam Backup & Replication License Usage

In this article

    You can get a representation of license usage information from connected 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://<hostname>:1281/v2/tenants/{ID}/licensing/backupServerUsage

    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/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",

       "unitType": "Instances"

       "rentalUnits": 100,

       "newUnits": 20,

       "usedUnits": 0,

       "rentalCount": 100,

       "newCount": 20,

       "usedCount": 0



       "type": "VBR_HyperV_VM",

       "unitType": "Instances"

       "rentalUnits": 50,

       "newUnits": 4,

       "usedUnits": 0,

       "rentalCount": 50,

       "newCount": 4,

       "usedCount": 0