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

Properties

The resources in the /resellers collection have a number of properties that reflect reseller settings. Properties can be used for POST, PUT, and DELETE requests and as query parameter values in GET requests.

Property

Type

Description

id

integer

System ID assigned to reseller in Veeam Availability Console RESTful API.

name

string

Reseller name.

enabled

boolean

Indicates whether a reseller is enabled in Veeam Availability Console.

tenantsUsage

integer

Number of companies managed by a reseller.

tenants

integer

Number of companies that a reseller can manage.

workstationAgentsUsage

integer

Number of Workstation Veeam backup agents managed by a reseller.

workstationAgentsNew

integer

Number of Workstation Veeam backup agents managed by a reseller that were registered (activated) within the current calendar month.

workstationAgents

integer

Number of Workstation Veeam backup agents that a reseller can store on a cloud repository. Must be specified if not unlimited.

serverAgentsUsage

integer

Number of Server Veeam backup agents managed by a reseller.

serverAgentsNew

integer

Number of Server Veeam backup agents managed by a reseller that were registered (activated) within the current calendar month.

serverAgents

integer

Number of Server Veeam backup agents that a reseller can store on a cloud repository. Must be specified if not unlimited.

cloudBackupResourceUsage

integer

Amount of cloud repository space consumed by reseller clients.

cloudBackupResource

integer

Amount of cloud repository space allocated to a reseller.

cloudReplicationResourceUsage

integer

Number of reseller clients assigned to hardware plans.

cloudReplicationResource

integer

Number of clients that a reseller can subscribe to a hardware plan.

vcdOrganizations

integer

Number of vCloud Director Organizations allocated to a reseller.

cloudReplicaType

string

Type of replication enabled for reseller clients.

isUnlimitedTenants

boolean

Indicates whether a reseller has unlimited quota for clients.

isUnlimitedWorkstationAgents

boolean

Indicates whether a reseller has unlimited quota for workstation agents.

isUnlimitedServerAgents

boolean

Indicates whether a reseller has unlimited quota for server agents.

description

string

Description of a reseller

dataTransferGb

integer

Amount of data that reseller clients are allowed to download from a cloud repository, in GB. The 0 value means the allowed amount is unlimited

firstName

string

First name of a reseller contact person

lastName

string

Last name of a reseller contact person

title

string

Indicates how to address a reseller contact person

Possible values:

  • Unknown
  • Mr
  • Miss
  • Mrs
  • Ms

The Unknown value must not be used in POST and PUT requests.

userName

string

Username of a Service Provider Global Administrator

userId

integer

System ID assigned to a Service Provider Global Administrator in Veeam Availability Console RESTful API

notes

string

Additional details or comments

companyId

string

Company ID

name

string

Reseller company name

country

integer

Country where a reseller company is located

taxId

string

Tax identification number

usState

integer

USA state where a company is located

zipCode

string

Postal code

domain

string

URL of a web site

city

string

City where a company is located

street

string

Street where a company is located

telephone

string

Contact phone number

emailAddress

string

Contact email address

_links

array

Links to related resources (navigation property).

Veeam Large Logo

Deployment Guide

Guide for Service Providers

Guide for End Users

Guide for Resellers

Usage Scenarios for Service Providers

RESTful API Reference