Help Center
Choose product document...
Veeam Availability Console 2.0 Update 1
RESTful API Reference

Get a Veeam Backup & Replication License

You can get a representation of a Veeam Backup & Replication server license with the specified ID.


To get a representation of a license, send the GET HTTPS request to the URL of its resource.

HTTP Request

GET https://<Availability-Console>:1281/v2/licensing/backupserverLicenses/{ID}

Request Headers

The request header must contain the authorization token for the current logon session.


The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 200 Success.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.




The length of the response body.


The media type and syntax of the request body message: application/json; charset=utf-8

Response Body

In the response body, Veeam Availability Console returns a representation of the /licensing/backupserverLicenses/{ID} resource.

Example Get a Veeam Backup & Replication License

The following request returns an entity representation of a license with ID c5aba79e-2ebf-4f7f-815c-33088d622cc5.


GET https://localhost:1281/v2/licensing/backupserverLicenses/c5aba79e-2ebf-4f7f-815c-33088d622cc5


Request Header:

Authorization: Bearer <Access-Token>


Response Code:

200 Success


Response Body:


   "id": "c5aba79e-2ebf-4f7f-815c-33088d622cc5",

   "contactPerson": "James Wilson",

   "edition": "Enterprise Plus",

   "licensedTo": "Delta AG",

   "licenseType": "Rental",

   "status": "Valid",

   "supportID": "123456789",

   "licenseExpirationDate": "2018-10-24T21:00:00Z",

   "supportExpirationDate": "2018-10-24T21:00:00Z",

   "licensedSockets": 0,

   "usedSockets": 0,

   "licensedVMs": 1000,

   "usedVMs": 521,

   "backupServerName": "BACKUP02",

   "companyName": "Delta",

   "locationName": "Default location",

   "newVMs": 18,

   "_links": {

     "self": {

       "href": ""


     "backupServers": [


         "href": ""





Veeam Large Logo

Deployment Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Quick Start Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Quick Start Guide for Enterprises

RESTful API Reference