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

Properties

The resources in the /backupAgents collection have a number of properties that reflect Veeam backup agent characteristics. Properties can be used for POST requests and as query parameter values in GET requests.

Property

Type

Description

id

string

System ID assigned to a Veeam backup agent.

scheduleDisabled

boolean

Indicates whether a Veeam backup agent job is scheduled.

companyId

integer

System ID assigned to a company to which a managed computer belongs.

locationId

integer

System ID assigned to a location to which a managed computer belongs.

name

string

Name of a managed computer.

successJobsCount

integer

Number of successful jobs.

totalJobsCount

integer

Number of all jobs.

successfulPercentage

integer

Number of successful jobs relative to all jobs, in percents.

guiMode

string

Indicates the UI access mode for the Veeam backup agent.

Possible values:

  • Na
  • ReadOnly
  • Full

isViewModeChanging

boolean

Indicates whether UI access mode is being changed at the moment.

vawPlatform

string

Backup agent platform.

Possible values:

  • Physical
  • Cloud

cloudCopy

boolean

Indicates whether a job stores files in cloud repository.

lastModified

string

Date and time when settings of the backup job were last modified.

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

lastModificationDoneBy

string

Name of the user who last modified job settings.

backupMode

array

Backup operation mode

Possible values:

  • Unknown
  • EntireComputer
  • Volume
  • Folder

operationMode

string

Indicates the operation mode of a backup agent.

Possible values:

  • UnLicensed
  • Server
  • Workstation

multijobSupport

boolean

Indicates whether an agent supports multiple jobs.

version

string

Version of Veeam backup agent deployed on a managed computer.

_links

Dictionary of string [key] and Object [value]

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