This is an archive version of the document. To get the most up-to-date information, see the current version.

General

The following properties are present in all resources from the /tenants collection:

Property	Type	Description
id	integer	System ID assigned to a company in the Veeam Service Provider Console REST API.
name	String	Company name configured in Veeam Cloud Connect or Veeam Service Provider Console.
instanceUid	String	System UID assigned to a tenant in Veeam Cloud Connect. Can be used as resource identifier.
cloudConnectAgentUid	String	System ID assigned to a management agent that is installed on the service provider backup server.
siteName	String	Name of a site that is assigned to a company.
vcdOrganizationUid	String	System ID assigned to a VCD organization that includes a company.
tenantType	String	Type of a company. Possible values: General VCD
description	String	Company description in Veeam Service Provider Console or tenant description in Veeam Cloud Connect.
title	String	Indicates how to address a company contact person. Possible values: Unknown Mr. Miss Mrs. Ms. The Unknown value must not be used in POST and PUT requests.
firstName	String	First name of a company contact person.
lastName	String	Last name of a company contact person.
userName	String	Name of a tenant in Veeam Cloud Connect.
emailAddress	String	Contact email address.
isEnabled	String	Indicates whether a tenant is enabled in Veeam Service Provider Console.
taxId	String	Company Tax ID.
telephone	String	Telephone number of a primary contact of a company.
country	String	Country where a company is located.
city	String	City where a company is located.
street	String	Street where a company is located.
usState	integer	System ID of a USA states where a company is located.
zipCode	String	Postal code.
domain	String	URL of a website.
companyId	String	ID of a company in Veeam Service Provider Console used for third party applications.
notes	String	Additional information on a company.
backupProtectionEnabled	Boolean	Indicates whether deleted backup file protection is enabled.
backupProtectionPeriod	integer	Number of days during which deleted backup files must be kept in the recycle bin on the Veeam Cloud Connect server.
networkFailoverResourcesEnabled	Boolean	Indicates whether network resources are alloceted to perform failover tasks.
numberOfPublicIp	integer	Number of public IP addresses assigned to a company.
publicIpEnabled	Boolean	Indicates whether public IP addresses are assigned to a company.
maxConcurrentTasks	integer	Maximum number of concurrent tasks available to a company.
bandwidththrottlingEnabled	Boolean	Indicates whether incoming network traffic that will be accepted from a company is limited.
allowedBandwidth	integer	Maximum incoming network traffic bandwidth that will be accepted from a company. If the bandwidththrottlingEnabled property has value false this property will return the latest saved value.
allowedBandwidthUnits	String	Measurement units for incoming network traffic accepted from a company. If the bandwidththrottlingEnabled property has value false this property will return the latest saved value.
gatewayPools	array	Collection of system IDs assigned to gateway pools that are allocated to a company. If the collection is empty, company will automatically use a standalone gateway.
gatewayFailoverEnabled	Boolean	Indicates whether failover to another gateway is enabled.
cloudGatewayPoolsUids	Array	Collection of system IDs assigned to gateway pools that are allocated to a company. If the collection is empty, company will automatically use a standalone gateway.
vMsBackedUp	integer	Number of virtual machines protected with backup jobs.
vMsReplicated	integer	Number of virtual machines protected with replication jobs.
vMsBackedupToCloud	integer	Number of virtual machines backed up to a cloud repository.
managedPhysicalWorkstations	integer	Number of physical workstation machines protected with Veeam backup agent.
managedCloudWorkstations	integer	Number of cloud workstation machines protected with Veeam backup agent.
managedPhysicalServers	integer	Number of physical server machines protected with Veeam backup agent.
managedCloudServers	integer	Number of cloud server machines protected with Veeam backup agent.
expirationEnabled	Boolean	Indicates whether a company account must be disabled automatically.
expirationDate	String	Date an time when a company account must be disabled. Date string is formatted in accordance with ISO 8601.
expirationTime	String	Date an time when a company account must be disabled. Date string is formatted in accordance with ISO 8601.
actions	Array	Actions performed by the POST method. Available actions: enable disable sendWelcomeLetter
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property). Can contain links to backup and replica resources, locations, users, and subscription plans. This property can be excluded from the response. For more information, see the SetLinks Custom Query Option (setLinks) section.