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

Properties

The resources in the /Tenants collection have a number of properties that reflect company or department characteristics in Veeam Availability Console. Properties can be used for POST requests and as query parameter values in GET requests.

Property

Type

Description

id

integer

System ID assigned to a company or department in Veeam Availability Console RESTful API.

name

string

Company or department name configured in Veeam Cloud Connect or Veeam Availability Console.

instanceUid

string

System UID assigned to a tenant in Veeam Cloud Connect. Can be used as resource identifier.

description

string

Company or department description in Veeam Availability Console or tenant description in Veeam Cloud Connect.

userName

string

Name of a tenant in Veeam Cloud Connect.

taxId

string

Company Tax ID.

telephone

string

Telephone number of a primary contact of a company or department.

country

string

Company or department country of residence.

companyId

string

ID of a company or department in Veeam Availability Console used for third party applications.

notes

string

Additional information on a company or department.

maxConcurrentTasks

integer

Maximum number of concurrent tasks available for a company or department.

bandwidththrottlingEnabled

boolean

Indicates whether incoming network traffic that will be accepted from a company or department is limited.

allowedBandwidth

integer

Maximum incoming network traffic bandwidth that will be accepted from a company or department.

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 or department.

If the bandwidththrottlingEnabled property has value false this property will return the latest saved value.

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 or department account must be disabled automatically.

expirationDate

string

Date when a company or department account must be disabled.

Date string is formatted in accordance with ISO 8601.

actions

Array

Actions performed by the POST method.

Available actions:

_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.

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