This is an archive version of the document. To get the most up-to-date information, see the current version.Get All License Usage Reports
You can get a collection resource representation of the Veeam licenses usage reports.
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 licenses usage reports, send the GET HTTP request to the URL of the /licensing/reports collection.
HTTP Request
GET https://<hostname>:1280/api/v3/licensing/reports |
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 SingleLicenseReport schema.
Example 
The following request returns a representation of licenses usage reports.
Request: GET https://localhost:1280/api/v3/licensing/reports
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 1, "count": 1, "offset": 0 } }, "data": [ { "reportParemeters": { "reportId": 10, "organizationName": "Veeam Software AG", "organizationUid": "e312fbbd-1e33-415d-8d38-b422c576523a", "licenseCompanyName": "Veeam Software AG", "generationDate": "2020-03-11T00:00:00.0000000-07:00", "reportInterval": { "startOfInterval": "2020-02-01T00:00:00.0000000-08:00", "endOfInterval": "2020-02-31T00:00:00.0000000-07:00" } }, "reportSummary": { "totalPoints": 5.0, "productsUsage": [ { "productType": "backupAndReplication", "totalPoints": 5.0, "licenseEdition": "Standard", "workloadUsage": [ { "workloadType": "vbR_VM", "initialCount": 2, "reportedCount": 1, "newCount": 0, "weight": 5.0, "usedPoints": 5.0 } ] } ] }, "organizationsUsage": [ { "organizationType": "company", "organizationName": "Beta", "organizationUid": "e312fbbd-1e33-415d-8d38-b422c576523a", "tenantUid": "cdb843a2-950d-47d0-bf81-b53cec59865b", "usedPoints": 5.0 } ], "notCollectedCloudServers": null, "usageDetails": [ { "organizationName": "Beta", "organizationUid": "e312fbbd-1e33-415d-8d38-b422c576523a", "tenantUid": "cdb843a2-950d-47d0-bf81-b53cec59865b", "supportId": "01276360", "notCollectedClientServers": [], "usageByLicenseAndProduct": [ { "licenseId": "11112222-1111-2222-3333-111122233333", "productType": "backupAndReplication", "licenseEdition": "Standard", "usedPoints": 5.0, "workloadUsage": [ { "workloadType": "vbR_VM", "initialCount": 2, "reportedCount": 1, "newCount": 0, "weight": 5.0, "usedPoints": 5.0 } ] }, { "licenseId": "11112222-1111-2222-3333-111122233333", "productType": "vspc", "licenseEdition": "EnterprisePlus", "usedPoints": 0.0, "workloadUsage": [ { "workloadType": "vaC_Workstation_Agent", "initialCount": 0, "reportedCount": 0, "newCount": 1, "weight": 4.0, "usedPoints": 0.0 }, { "workloadType": "vaC_Server_Agent", "initialCount": 0, "reportedCount": 0, "newCount": 1, "weight": 11.0, "usedPoints": 0.0 } ] } ] } ], "appendices": [] } ] } |