Installing and Updating License
This section explains how to install and update a license in Veeam Backup for Microsoft Office 365.
Request
POST https://<hostname>:4443/v5/License/action |
Request Headers
The request header must contain an authorization token of the current session.
Request Body
Install
To install a license, the request body must contain the install action property:
Property | Type | Description |
|---|---|---|
licenseFile | object | Specifies the content of the license file provided as a Base64 string. For more information about how to obtain a Base64 string, see Converting License to Base64 String. |
For example:
Request Body: { "install": { "licenseFile": "<base64_string>" } } |
Converting License to Base64 String
To install a license, you must provide the content of the license file as a Base64 string. To obtain a Base64 string, perform the following steps:
- Get the content of the license file.
- Convert the license to a Base64 string.
To do this, you can use the following PowerShell cmdlets:
$license = get-content '<path_to_license>' -Encoding Byte [System.Convert]::ToBase64String($license) | Out-File '<path_to_file>' |
where:
- <path_to_license> — path to the license file that you want to convert to a Base64 string.
- <path_to_file> — path to a file that that will contain the resulting Base64 string. You will be able to copy the Base64 string from the file and provide the string in the body of the POST https://<hostname>:4443/v5/License/action request.
For example:
$license = get-content 'C:\veeam.lic' -Encoding Byte [System.Convert]::ToBase64String($license) | Out-File 'C:\base64.txt' |
Update
To update a license, the request body must contain the update action:
Request Body: { "update": null } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 201 Created.
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
In the response body, the server returns a resource representation of the /License resource.
Example 1
The example below shows how to install a license in Veeam Backup for Microsoft Office 365.
Request: POST https://abc.tech.local:4443/v5/License/action
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "install": { "licenseFile": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPExpY2Vuc2VzPjxMaWNlbnNlPjwhW0NEQVRBW0FkZGl0aW9uYWwgU2lnbmF0dXJlPTdGRjRFOUY4MDY2QzgzNzIxNDhFQUVCRDg5NTQzQkNGRUY1MzU5OUE2NjBENTVCREMyNzhFMjk2QUQ3Q0IzOTNDNjEzMDczMUQ0N0ZDQ0FEMDg2RjVBMTUyM0ZDRDkwMDM5REMxREU5NTM1RDEzNjE0OEQ5NzExNjlGQ0ZCMkZBQTc2NUNGRTdEMjM5Q0M2RjlDRUI2ODMwMDJCNEQ3MDU4MzI0MEFBQTJDNDM5OENBNzZCNzFEQTlBMUJDNEY4NEI2RTdDNTYyRUYzMUI5RTlCNTVDNEJFQTBGOUI1QTBERkM1Mzk1MjA1MkZBOEQ5RjI5Nzk4RDI4QzRFMTQ5QUU5NjEyQ0YwM0IwNTdGODlFMzFFQTU1RDk0QTAzMzg1MEJDODNCNEE0NzQ5OEJBMUQwNTE3MUEyMDJGQzU0QzVFODI4OEY2M0YzNjc2MjAxNEUwMzNGNkFBMzQwRTAzOTE2REUxQzM5RDcyMEUzQUUwMjFDNzE2OTgwMzkzQUMyMzU3OEE0NUIxM0RDNjc2QTIwMjQ3MUY1MDk5NzlFQTE3RDdENEFGNDc5MkZCMjM1QkY3NzA5NEJDQjEwQUEwQTNFOEQzQ0JGMTg3MDZCQzdDQjBENUExNTZCMjMxRTQ4MUEyQTQ3MTZGRDQ0NUFEOTY2MkY2MDYyRkYwMjU1Mjk3NDkwNUUyOTk5ODMyNjVCMEY3NjM3M0NEQzBEMUU1RUE2QjE0OEIwMDdBOUU1NUM0OEMzMEMyQUU5OEQ4MzE0QjM4RDdENzY5M0YzQ0Y5RTY1OTA4MTgyRkMzMEZDRDVCQzQzQkZBNzdDREY5MDNGMDdFQkFENkYxMkIyQTVDNDg0RTY4MzExNzQzN0MxRDIwOUEwODAzN0RCNzBENEY5REFEQjBCNkMzNTg3RDVGNDYyNUVBODk4RDc0NzM4OUY4NzMzRjA1RjVGN0VBMzUwQ0MxOTQ2ODcxRjY5RTlERTg2RjU4RDhENjQ1QUI2QjI1OTJGOUZCRDUyMEU2MXYZXYZXYZXYZXYZT1WZWVhbSBTb2Z0d2FyZSBHbWJIDQpEZXNjcmlwdGlvbj1Db3B5cmlnaHQgMjAyMCBWZWVhbSwgSW5jLiBBbGwgUmlnaHRzIFJlc2VydmVkLiBUaGUgU29mdHdhcmUgUHJvZHVjdCBpcyBwcm90ZWN0ZWQgYnkgY29weXJpZ2h0IGFuZCBvdGhlciBpbnRlbGxlY3R1YWwgcHJvcGVydHkgbGF3cyBhbmQgdHJlYXRpZXMuIFZlZWFtIG9yIGl0cyBzdXBwbGllcnMgb3duIHRoZSB0aXRsZSwgY29weXJpZ2h0LCBhbmQgb3RoZXIgaW50ZWxsZWN0dWFsIHByb3BlcnR5IHJpZ2h0cyBpbiB0aGUgU29mdHdhcmUgUHJvZHVjdC4gVmVlYW0gcmVzZXJ2ZXMgYWxsIHJpZ2h0cyBub3QgZXhwcmVzc2x5IGdyYW50ZWQgdG8geW91IGluIEVVTEEuIFRoZSBTb2Z0d2FyZSBQcm9kdWN0IGlzIGxpY2Vuc2VkLCBub3Qgc29sZC4gVmVlYW0gZ3JhbnRzIHRvIHlvdSBhIG5vbmV4Y2x1c2l2ZSBub250cmFuc2ZlcmFibGUgbGljZW5zZSB0byB1c2UgdGhlIFNvZnR3YXJlIFByb2R1Y3QsIHByb3ZpZGVkIHRoYXQgeW91IGFncmVlIHdpdGggRVVMQS4NCkUtbWFpbD1hZG1pbmlzdHJhdG9yLXJkQHZlZWFtLmNvbQ0KRXhwaXJhdGlvbiBkYXRlPTIwLzA5LzIwMjENCkZpcnN0IG5hbWU9RGV2IGFuZCBRQQ0KTGFzdCBuYW1lPURlcGFydG1lbnRzDQpMaWNlbnNlIGluZm9ybWF0aW9uPUxpY2Vuc2VkIHByb2R1Y3Q6XHRWZWVhbSBCYWNrdXAgZm9yIE1pY3Jvc29mdCBPZmZpY2UgMzY1XG5MaWNlbnNlIHR5cGU6XHRTdWJzY3JpcHRpb25cbkxpY2Vuc2VkIHRvOlx0VmVlYW0gU29mdHdhcmUgR21iSFxuQ29udGFjdCBwZXJzb246XHREZXYgYW5kIFFBIERlcGFydG1lbnRzXG5Vc2VyczpcdDEwMA0KTGljZW5zZSB0eXBlPVN1YnNjcmlwdGlvbg0KUHJvZHVjdD1WZWVhbSBCYWNrdXAgZm9yIE1pY3Jvc29mdCBPZmZpY2UgMzY1DQpTdXBwb3J0IGV4cGlyYXRpb24gZGF0ZT0yMC8wOS8yMDIxDQpTdXBwb3J0SUQ9MDA3ODI2MTkNClVzZXJzPTEwMA0KVmVyc2lvbj1YDQpTaWduYXR1cmU9NkNENkQ3MzRFMjUzOTM1MDA2NUNFRjg0MTcxQ0M1OUFERjE4NjczMTFGODhFMzA4MjVERDU3NzJERTIyNzZDNEJEQzA1RTkxOTIxOTdGNUI2M0JFMDFFRTZBQjAxNzEwQTEyMURBREYzODQxM0U5OUQ2MUM5QUE1NTMyMkJERDNFMUQyMTBGM0NFMDM2NkM3MUQ0RDExQUQ2MjEyMzREOEJCRUFEQTAxOTRFMDUxM0NFMUY3RTg3RjIwRDY3REE5MThEMDAwNjYxRDZGOENFQzhDQkFFNDFFRDc3QjY2MzQ2MDg3ODcyMDM2N0M0MDJDOEIzRTBFMjgyMTc5RTQyMA0KXV0+PC9MaWNlbnNlPjwvTGljZW5zZXM+DQo=" } }
Response: 201 Created
Response Body: { "status": "Valid", "expirationDate": "2021-09-20T00:00:00", "type": "Subscription", "licensedTo": "ABC Company", "contactPerson": "ABC Company Admin", "totalNumber": 100, "usedNumber": 10, "supportId": "00000000", "supportExpirationDate": "2021-09-20T03:00:00+03:00" } |
Example 2
The example below shows how to update a license in Veeam Backup for Microsoft Office 365.
Request: POST https://abc.tech.local:4443/v5/License/action
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "update": null }
Response: 201 Created |