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

Properties

The resources in the /Users collection have a number of properties that reflect user characteristics in Veeam Availability Console. Properties can be used as query parameter values in GET requests.

Property

Type

Description

id

integer

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

firstName

string

User first name configured in Veeam Availability Console.

lastName

string

User last name configured in Veeam Availability Console.

userName

string

User login name assigned automatically or configured in Veeam Availability Console.

role

string

User role in Veeam Availability Console.

Possible values:

  • VAC Administrator
  • VACOperator
  • Company Owner
  • Department Owner
  • Company Administrator
  • Department Administrator
  • Company User
  • Department User
  • Subtenant
  • Invoice Auditor
  • Chargeback Auditor

title

string

User title.

Possible values:

  • Mr.
  • Miss
  • Mrs.
  • Ms.

status

string

User status.

Possible values:

  • Enabled
  • Disabled

email

string

User email address configured in Veeam Availability Console.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property). Can contain links to locations and backup resources.

User Backup Resources

If the role property has value Subtenant, the /Users/{ID} resource has the /Users/{ID}/BackupResources sub-resource with the following properties:

Property

Type

Description

id

integer

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

quotaName

string

Name of a cloud repository configured for a user.

storageQuota

integer

Amount of storage space allocated to a user.

storageQuotaUnits

string

Measurement units for storage space allocated to a user.

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

usedStorageQuota

integer

Amount of allocated storage space already used by a user.

usedStorageQuotaUnits

string

Measurement units for storage space already used by a user.

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

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

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