Get Veeam Service Provider Console Licenses Usage by Tenant
You can get a resource representation of Veeam Service Provider Console license usage by a tenant 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 resource representation of Veeam Service Provider Console license usage by a tenant, send the GET HTTP request to the URL of the /licensing/console/usage/companies/vcc/{tenantUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/licensing/console/usage/companies/vcc/{tenantUid} |
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 |
|---|---|---|---|---|---|
tenantUid | Path | String (uuid) | Yes | — | Tenant 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 CompanyConsoleLicenseUsage schema.
Example 
The following request returns a representation of all Veeam Backup & Replication server licenses usage by a tenant with UID b4971992-84ac-4dee-b837-95c8db275f28.
Request: GET https://localhost:1280/api/v3/licensing/backupServer/usage/companies/vcc/b4971992-84ac-4dee-b837-95c8db275f28
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "companyUid": "f886afdf-af2b-4e31-9f1e-7c0e96a0ee5e", "tenantUid": "b4971992-84ac-4dee-b837-95c8db275f28", "counters": [ { "type": "vaC_Server_Agent", "unitType": "points", "usedUnits": 0.0, "usedCount": 0, "newUnits": 22.0, "newCount": 2 }, { "type": "vaC_Workstation_Agent", "unitType": "points", "usedUnits": 0.0, "usedCount": 0, "newUnits": 8.0, "newCount": 2 } ] } } |
