This is an archive version of the document. To get the most up-to-date information, see the current version.Get All Site Licenses Usage
You can get a collection resource representation of site licenses usage.
Required Privileges
To perform this task, a user must have the Portal Administrator role assigned.
Request
To get representation of site licenses usage, send the GET HTTP request to the URL of the /licensing/sites/usage collection.
HTTP Request
GET https://<hostname>:1280/api/v3/licensing/sites/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. |
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 SiteCloudLicenseUsage schema.
Example 
The following request returns a representation of all site licenses usage.
Request: GET https://localhost:1280/api/v3/licensing/sites/usage
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": [ { "installationId": "34c16e5e-37d8-4a1c-8c16-c032846c11d1", "siteUid": "365be228-b14d-421a-9a0e-a1a4a3e2195c", "licenseId": "BackupServerLicense_BackupServer:365be228-b14d-421a-9a0e-a1a435f2195c34c16e5e-37d8-4a1c-8c16-c0ae846c11d1", "counters": [] }, { "installationId": "6a5e8f1e-7155-4706-998d-886af6bc587c", "siteUid": "890a52cd-4eaf-428e-81f8-886a365c9c16", "licenseId": "BackupServerLicense_BackupServer:890a52cd-4eaf-428e-81f8-016a36819c166a918f1e-7155-4706-998d-886af6bc587c", "counters": [] }, { "installationId": "e5b81ae9-e316-41ee-9c75-39f405337bd9", "siteUid": "4aa2a01c-d14f-4d6e-b0fa-2e1e642891e3", "licenseId": "BackupServerLicense_BackupServer:4aa2a01c-d14f-4d6e-b0fa-2e1e961291e3e8881ae9-e316-41ee-9c75-39f405337bd9", "counters": [ { "type": "CC_VM_Replica", "unitType": "points", "rentalUnits": 0.0, "newUnits": 10.0, "usedUnits": 0.0, "rentalCount": 0, "newCount": 1, "usedCount": 0 } ] } ] } |