This is an archive version of the document. To get the most up-to-date information, see the current version.Get All Veeam Backup & Replication Licenses
You can get a collection resource representation of the licenses installed on all managed Veeam Backup & Replication servers.
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 licenses installed on all managed Veeam Backup & Replication servers, send the GET HTTP request to the URL of the /licensing/backupServers collection.
HTTP Request
GET https://<hostname>:1280/api/v3/licensing/backupServers |
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 BackupServerLicense schema.
Example 
The following request returns a representation of the licenses installed on all managed Veeam Backup & Replication servers.
Request: GET https://localhost:1280/api/v3/licensing/backupServers
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "backupServerUid": "a26ad214-e225-49bf-8fb8-f16340729b7b", "autoUpdateEnabled": false, "edition": "Enterprise Plus", "monitoring": false, "packages": [ "backup" ], "company": "Alpha", "email": "a.smith@alpha.com", "contactPerson": "Alan Smith", "expirationDate": "2020-09-09T10:00:00+03:00", "supportExpirationDate": "2020-09-09T10:00:00+03:00", "licenseIds": [], "supportIds": [ "00276360" ], "sectionTypes": [ "instance" ], "status": "valid", "cloudConnect": "no", "sockets": 0.0, "usedSockets": 0.0, "capacity": 0.0, "usedCapacity": null, "units": 1000.0, "usedUnits": 0.0, "unitType": "instances", "type": "rental" }, { "backupServerUid": "976d4924-ae52-4ccc-b14b-88221f1451e8", "autoUpdateEnabled": false, "edition": "Enterprise Plus", "monitoring": null, "packages": [ "backup" ], "company": "Beta", "email": "b.johns@veeam.com", "contactPerson": "Bill Johns", "expirationDate": "2020-12-30T11:00:00+03:00", "supportExpirationDate": null, "licenseIds": [ "33882222-1111-2222-3333-111122233333" ], "supportIds": [ "00123456" ], "sectionTypes": [ "instance" ], "status": "valid", "cloudConnect": "no", "sockets": 0.0, "usedSockets": 0.0, "capacity": null, "usedCapacity": null, "units": 1000.0, "usedUnits": 0.0, "unitType": "points", "type": "rental" } ] } |