This is an archive version of the document. To get the most up-to-date information, see the current version.Getting Licenses
This section explains how to get information about the installed license.
Request
GET https://<hostname>/api/v1/license |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
None.
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
Property | Type | Description |
|---|---|---|
licenseType | string | Shows the type of the license. |
instancesUses | integer | Shows the number of used instances. |
instances | integer | Shows how many instances the installed license is able to protect. |
company | string | Shows the name of the organization to which the license was issued. |
string | Shows the email of the organization. | |
licenseExpires | string | Shows the date when the license expires. |
licenseId | string | Shows the identification number of the license. |
supportId | string | Shows the support identification number. |
gracePeriodDays | integer | Shows the grace period that applies once the license if expired. |
Example
Request: GET https://abc.ukwest.cloudapp.azure.com/api/v1/license
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "licenseType": "Subscription", "instancesUses": 1, "instances": 100, "company": "Veeam Software", "email": "rd@veeam.com", "licenseExpires": "2020-04-01T00:00:00", "licenseId": "6F9619FF-8B86-D011-B42D-00CF4FC964FF", "supportId": "12345678", "gracePeriodDays": 30 } |