This is an archive version of the document. To get the most up-to-date information, see the current version.Get Veeam Backup & Replication License Usage
You can get a resource representation of license usage by the Veeam Backup & Replication server with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator.
Request
To get a representation of license usage by the Veeam Backup & Replication server, send the GET HTTP request to the URL of the /licensing/backupServers/{backupServerUid}/usage resource.
HTTP Request
GET https://<hostname>:1280/api/v3/licensing/backupServers/{backupServerUid}/usage |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
backupServerUid | Path | String (uuid) | Yes | — | Veeam Backup & Replication server UID |
Response
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.
Header | Description |
Content-length | The length of the response body. |
Content-type | 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 resource representation based on the BackupServerLicenseUsage schema.
Example 
The following request returns a representation of license usage by a Veeam Backup & Replication sites with UID 0db630d9-7c20-44a3-bf64-0a97c58cda7c.
Request: GET https://localhost:1280/api/v3/licensing/sites/0db630d9-7c20-44a3-bf64-0a97c58cda7c/usage
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "backupServerUid": "0db630d9-7c20-44a3-bf64-0a97c58cda7c", "installationId": "da6954c9-4100-4c08-bf14-c6f123d8c424", "counters": [ { "type": "VBR_vSphere_VM", "unitType": "instances", "newUnits": 0.0, "usedUnits": 2.0, "newCount": 0, "usedCount": 2 } ] } } |