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

Properties

The /BackupserverLicenses resource has a number of properties that reflect license characteristics. Properties can be used as query parameter values in GET requests.

Property

Type

Description

id

string

System ID assigned to a Veeam Backup & Replication license in Veeam Availability Console RESTful API.

contactPerson

string

Name of a contact person in an organization to which the license is issued.

edition

string

Type of Veeam Backup & Replication product edition.

Possible values:

  • Standard
  • Enterprise
  • EnterprisePlus

licensedTo

string

Name of a person or organization to which the license is issued.

licenseType

string

Type of the license.

Possible values:

  • NotInstalled
  • Rental
  • NFR
  • Perpetual
  • Evaluation
  • Subscription

status

string

Current status of the license.

Possible values:

  • Unknown
  • Valid
  • Warning
  • Error

supportID

string

Support ID required for contacting Veeam Support.

licenseExpirationDate

string

License expiration date and time.

Date and time string is formatted in accordance with ISO 8601.

supportExpirationDate

string

Support expiration date and time.

Date and time string is formatted in accordance with ISO 8601.

licensedSockets

integer

Number of licensed sockets.

usedSockets

integer

Number of used sockets.

licensedVMs

integer

Number of licensed VMs.

usedVMs

integer

Number of used VMs.

backupServerName

string

Name of a Veeam Backup & Replication server to which license is uploaded.

companyName

string

Name of a company or department in Veeam Availability Console to which the licensed server belongs.

locationName

string

Name of a company or department location at which the licensed server is located.

newVMs

integer

Number of VMs treated as New (for rental licenses).

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property). Contains a link to the backup server, on which license was installed.

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