This is an archive version of the document. To get the most up-to-date information, see the current version.Get Veeam Service Provider Console License Usage by All Companies
You can get a resource representation of the Veeam Service Provider Console license usage by companies.
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 the Veeam Service Provider Console license usage by companies, send the GET HTTP request to the URL of the /licensing/console/usage/companies collection.
HTTP Request
GET https://<hostname>:1280/api/v3/licensing/console/usage/companies |
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 |
|---|---|---|---|---|---|
limit | Query | Integer (int32) | No | 100 | Specifies the first N resources that must be returned in the output |
offset | Query | Integer (int32) | No | 0 | Excludes the first N resources from the query output |
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 collection resource representation based on the CompanyConsoleLicenseUsage schema.
Example 
The following request returns a representation of all Veeam Service Provider Console license usage by all companies.
Request: GET https://localhost:1280/api/v3/licensing/console/usage/companies
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "companyUid": "20c8486b-8c20-4b24-86a5-7ca10751c504", "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 } ] }, { "companyUid": "1885437f-db1c-89fc-b4f1-2f54b506a353", "tenantUid": "ab1fa3a6-b60b-5470-b182-a8b1de57fd94", "counters": [ { "type": "VAC_Server_Agent", "unitType": "points", "usedUnits": 0.0, "usedCount": 0, "newUnits": 11.0, "newCount": 1 }, { "type": "VAC_Workstation_Agent", "unitType": "points", "usedUnits": 0.0, "usedCount": 0, "newUnits": 4.0, "newCount": 1 } ] } ] } |