Help Center
Choose product document...
Veeam Availability Console 3.0
RESTful API Reference

Properties

The resources in the /tenants/{ID}/backupResources collection have a number of properties that reflect cloud repository resource characteristics. Properties can be used as query parameter values in GET requests.

Property

Type

Description

id

integer

System ID assigned to a backup resource in Veeam Availability Console RESTful API.

cloudRepositoryName

string

Name of a cloud repository configured for a company.

providerRepositoryUid

string

System ID assigned to a repository of a service provider in Veeam Backup & Replication.

storageQuota

integer

Amount of storage space allocated to a company.

storageQuotaUnits

string

Measurement units for storage space allocated to a company.

Possible values: B (byte) and its multiples formed with metric prefixes.

vMsQuota

integer

Number of VMs that a company can store on a cloud repository. If quota is unlimited, the property value is 0.

quotasAreUnlimited

boolean

Indicates whether a company has unlimited quotas for VMs, workstations and servers.

serversQuota

integer

Number of servers that a company can store on a cloud repository. If quota is unlimited, the property value is 0.

workstationsQuota

integer

Number of workstations that a company can store on a cloud repository. If quota is unlimited, the property value is 0.

trafficQuota

integer

Amount of data that a company can download from the cloud repository during a billing period. If quota is unlimited, the property value is 0.

trafficQuotaUnits

string

Measurement units for the data that a company can download from the cloud repository.

Possible values: B (byte) and its multiples formed with metric prefixes.

wanAccelerationEnabled

boolean

Indicates whether WAN Accelerator is enabled for data transfer to a cloud repository.

usedStorageQuota

integer

Amount of allocated storage space already used by a company.

usedStorageQuotaUnits

string

Measurement units for allocated storage space already used by the company.

Possible values: B (byte) and its multiples formed with metric prefixes.

usedTrafficQuota

integer

Amount of data that a company has already downloaded from a cloud repository during a billing period. If quota is unlimited, the property value is -1.

usedTrafficQuotaUnits

string

Measurement units for the data that a company has already downloaded from a cloud repository.

Possible values: B (byte) and its multiples formed with metric prefixes.

intervalStartTime

string

Start date of data collection.

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

intervalEndTime

string

End date of data collection.

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

backupRepositoryUid

string

System UID assigned to a cloud repository.

cloudRepositoryFriendlyName

string

Cloud repository name that is displayed to a company user.

quota

integer

Set of limitations for a company.

Includes the following sections:

  • storageGb — amount of storage space allocated to a company measured in GB.
  • quotasIsUnlimited — indicates whether a company has unlimited quotas for number of VMs, workstations and servers
  • vms — number of VMs that a company can store on a cloud repository.
  • workstations — number of workstation that a company can store on a cloud repository.
  • servers — number of servers that a company can store on a cloud repository.

isWanAccelerationEnabled

boolean

Indicates whether WAN Accelerator is enabled for data transfer to a cloud repository.

wanAcceleratorUid

string

System ID assigned to a WAN Accelerator.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property). Can contain links to WAN Accelerators and backup repositories.

Veeam Large Logo

Deployment Guide

Guide for Service Providers

Guide for End Users

Guide for Resellers

Usage Scenarios for Service Providers

RESTful API Reference