This is an archive version of the document. To get the most up-to-date information, see the current version.Properties
The /licenseSettings resource has a number of properties that reflect license characteristics. Properties can be used in POST requests and as query parameter values in GET requests.
Property | Type | Description |
|---|---|---|
autoupdateEnabled | Boolean | Indicates whether license updates automatically. |
productName | String | Name of software product for which the license is issued. |
status | String | Current status of the license. |
type | String | Type of the license. Possible values:
|
licenseEdition | String | Type of a product edition. Possible values:
|
licenseString | String | License edition type that is displayed in user interface. |
licenseTo | String | Name of an organization to which the license is issued. |
contactPerson | String | Name of a contact person in an organization to which the license is issued. |
licenseAdministratorEmail | String | Email address of a license administrator in an organization to which the license is issued. |
licenseeEmail | String | Email address of a contact person. |
licensesCount | integer | Number of licenses available. A license here is a unit (or token) that is assigned to a licensed object in Veeam Service Provider Console. |
licensesUsedCount | integer | Number of licenses already used. |
cloudConnectType | String | License operation mode. Possible values:
|
supportID | String | Support ID required for contacting Veeam Support. |
licenseID | String | System ID of the license. |
expirationDate | 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. |
lastUpdateDate | String | Date and time of the latest license update attempt. Date and time string is formatted in accordance with ISO 8601. |
vmCount | integer | Number of VMs protected on managed Veeam Backup & Replication servers. |
workstationAgents | integer | Number of workstations protected with licensed Veeam backup agent (Workstation Edition). |
serverAgents | integer | Number of servers protected with licensed Veeam backup agent (Server Edition). |
workstationCount* | integer | Number of workstations protected with licensed Veeam backup agent (Workstation Edition). |
serverCount* | integer | Number of servers protected with licensed Veeam backup agent (Server Edition). |
cloudWorkstationCount* | integer | Number of VMs protected with licensed Veeam backup agent (Workstation Edition). |
cloudServerCount* | integer | Number of VMs protected with licensed Veeam backup agent (Server Edition). |
cloudconnectBackupVmCount | integer | Number of VMs protected by tenants in Veeam Cloud Connect. |
cloudconnectBackupWorkstationCount | integer | Number of workstations protected by tenants in Veeam Cloud Connect. |
cloudconnectBackupServerCount | integer | Number of servers protected by tenants in Veeam Cloud Connect. |
cloudconnectReplicationVmCount | integer | Number of VMs replicated by tenants in Veeam Cloud Connect. |
package | String | License package type. Possible values:
|
actions | Array | Actions performed by the POST method. Available actions: |
* Properties are deprecated and remain for backward compatibility purposes.
