Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
RESTful API Reference

(GET) /cloud/tenants/{ID}/freelicenseCounters

Returns a resource representation of Veeam Cloud Connect license counters that display the number of new and rental machines.

Request

To get a list of cloud gateway pools assigned to the tenant, you need to send the GET HTTP request to the URL of the /cloud/tenants/{ID}/freelicenseCounters resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/api/cloud/tenants/{ID}/freelicenseCounters

Request Headers

The request contains the following headers:

Header

Required

Description

X-RestSvcSessionId

True

The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security.

Accept

False

Identifies the format of the response. Possible values:

  • application/xml — the client can sent this value in the header to accept response in the XML format.
  • application/json — the client must send this value in the header to accept the request in the JSON format.

If the request does not contain the header, the server will return the response in the XML format.

Request Body

None.

Query Parameters

None.

Response

The server returns the following response to the client.

Response Codes

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. Possible values:

  • application/xml
  • application/json

Response Body

In the response body, Veeam Backup Enterprise Manager returns a representation of the /cloud/tenants/{ID}/freelicenseCounters resource.

Example

The example below returns counters of new and rental machines for the tenant account with ID 8f5221e7-eb42-4c34-bd64-102033a909fa.

Request:

GET http://localhost:9399/api/cloud/tenants/8f5221e7-eb42-4c34-bd64-102033a909fa/freelicenseCounters

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<CloudTenantFreeLicenseCounters Href="https://local.host:9398/api/cloud/tenants/8f5221e7-eb42-4c34-bd64-102033a909fa/freelicenseCounters" xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <Links>
   <Link Href="https://local.host:9398/api/cloud/tenants/8f5221e7-eb42-4c34-bd64-102033a909fa?format=Entity" Name="TechCompany" Type="CloudTenant" Rel="Up"/>
 </Links>
 <RentalVMBackupCount>50</RentalVMBackupCount>
 <RentalWorkstationBackupCount>50</RentalWorkstationBackupCount>
 <RentalServerBackupCount>50</RentalServerBackupCount>
 <NewVMBackupCount>50</NewVMBackupCount>
 <NewWorkstationBackupCount>50</NewWorkstationBackupCount>
 <NewServerBackupCount>50</NewServerBackupCount>
</CloudTenantFreeLicenseCounters>

 

 

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions Reference

Veeam Availability for Nutanix AHV Documentation

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation