Get Veeam Backup & Replication License
You can get a resource representation of a license installed on a managed Veeam Backup & Replication server 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 representation of a license installed on a managed Veeam Backup & Replication server, send the GET HTTP request to the URL of the /licensing/backupServers/{backupServerUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/licensing/backupServers/{backupServerUid} |
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 |
---|---|---|---|---|---|
backupServerUid | Path | String (uuid) | Yes | — | Veeam Backup & Replication server 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 BackupServerLicense schema.
Example
The following request returns a representation of a license installed on a license with UID 120f1c58-76d4-4b5b-993d-9983554c5f6f.
Request: GET https://localhost:1280/api/v3/licensing/backupServers/120f1c58-76d4-4b5b-993d-9983554c5f6f
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "backupServerUid": "120f1c58-76d4-4b5b-993d-9983554c5f6f", "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" } } |