Get Veeam Backup & Replication Licenses

You can get a representation of a collection licenses for Veeam Backup & Replication servers managed in Veeam Service Provider Console.

Request

To get a representation of all tenant server licenses, send the GET HTTPS request to the URL of the /licensing/backupserverLicenses collection.

HTTP Request

GET https://<hostname>:1281/v2/licensing/backupserverLicenses

Request Headers

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

Response

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.

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 representation of the /licensing/backupserverLicenses collection.

Example Get Veeam Backup & Replication Licenses

The following request returns a representation of all licenses of tenant Veeam Backup & Replication servers.

Request:

GET https://localhost:1281/v2/licensing/backupserverLicenses

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response Code:

200 Success

 

Response Body:

[

 {

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

   "contactPerson": "James Wilson",

   "licenseIds": [

     29bf0e25-359a-4854-8919-f4840d83fbc8

   ],

   "licenseAdministratorEmail": "admin@delta.com",

   "licenseeEmail": "j_wilson@delta.com",

   "edition": "Enterprise Plus",

   "monitoring": "Yes",

   "licensedTo": "Delta AG",

   "licenseType": "Rental",

   "status": "Valid",

   "supportID": "123456789",

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

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

   "licensedSockets": 0,

   "usedSockets": 0,

   "licensedVMs": 0,

   "usedVMs": 0,

   "backupServerName": "BACKUP02",

   "companyName": "Delta",

   "locationName": "Default location",

   "newVMs": 0,

   "totalInstances": 1000,

   "usedInstances": 521,

   "packages": [

     "Backup"

   ],

   "sectionTypes": [

     "Instance"

   ],

   "_links": {

     "self": {

       "href": "https://vac.tech.local:1281/v2/backupLicenses/c5aba79e-2ebf-4f7f-815c-33088d622cc5"

     },

     "backupServers": [

       {

         "href": "https://vac.tech.local:1281/v2/backupServers/2"

       }

     ]

   }

 },

 {

   "id": "089cc472-302f-4ee2-aca5-24ce0ac513a1",

   "contactPerson": "Maddison Grace",

   "licenseIds": [

     d7d6b91e-763f-4588-810e-d00f156fb19b

   ],

   "licenseAdministratorEmail": "admin@alpha.com",

   "licenseeEmail": "m_grace@delta.com",

   "edition": "Enterprise Plus",

   "monitoring": "No",

   "licensedTo": "Alpha Enterprise",

   "licenseType": "Rental",

   "status": "Valid",

   "supportID": "987456321",

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

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

   "licensedSockets": 0,

   "usedSockets": 0,

   "licensedVMs": 1000,

   "usedVMs": 862,

   "backupServerName": "BACKUP03",

   "companyName": "Alpha",

   "locationName": "Default location",

   "newVMs": 90,

   "totalInstances": 0,

   "usedInstances": 0,

   "packages": [

     "Backup"

   ],

   "sectionTypes": [

     "Instance"

   ],

   "_links": {

     "self": {

       "href": "https://vac.tech.local:1281/v2/backupLicenses/089cc472-302f-4ee2-aca5-24ce0ac513a1"

     },

     "backupServers": [

       {

         "href": "https://vac.tech.local:1281/v2/backupServers/3"

       }

     ]

   }

 }

]

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.