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

Properties

The resources in the /Computers collection have a number of properties that reflect discovered computer 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 computer in Veeam Availability Console RESTful API.

hostName

string

Name of a discovered computer.

type

string

Type of a discovered computer OS.

Possible values:

  • Unknown
  • DomainController
  • Server
  • Workstation

platformType

string

Type of platform on which a discovered computer runs.

Possible values:

  • Unknown
  • Windows
  • Vmware
  • HyperV
  • Linux
  • Azure
  • Amazon

guestOs

string

Guest OS installed on a discovered computer.

applicationInstalled

string

Application detected on a computer by Veeam Availability Console.

connectionStatus

string

Computer connection status.

Possible values:

  • Online
  • Offline
  • Rejected

connectionAccount

string

Сompany owner user name that is used to connect Veeam Availability Console management agent to a cloud gateway.

lastHeartbeat

string

Date and time when a management agent on a computer sent the latest heartbeat to Veeam Availability Console.

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

progress

integer

Percentage of Veeam backup agent deployment progress displayed as a decimal fraction.

ipAddress

string

Computer IP-address.

macAddress

string

Computer MAC-address.

discoveryTime

string

Date and time of computer discovery.

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

backupAgentInstalled

boolean

Indicates whether backup agent is installed on a computer.

vacAgentStatus

string

Status of Veeam Availability Console management agent.

Possible values:

  • Installed
  • Warning
  • Inaccessible
  • Not Installed

vacAgentVersion

string

Version of Veeam Availability Console management agent.

vacAgentRole

string

Role of Veeam Availability Console management agent.

Possible values:

  • Master
  • Client

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 policies assigned to a computer.

Backup Agent

If the backupAgentInstalled property has value true the resource has the following additional properties:

Property

Type

Description

vawAgentStatus

string

Status of Veeam backup agent.

Possible values:

  • Healthy
  • Warning
  • Error
  • Unknown

vawAgentVersion

string

Version of Veeam backup agent installed on a discovered computer.

backupSize

integer

Total amount of backed up data.

backupSizeUnits

string

Measurement units for backed up data.

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

activationDate

string

Date and time when Veeam backup agent was activated.

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

licenceType

string

Type of license installed for Veeam backup agent.

Possible values:

  • Paid (Standalone)
  • Activated
  • Free
  • Activated (managed by backup server)

nextRun

string

Date and time when the next Veeam backup agent job session starts.

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

scheduleType

string

Type of schedule set for Veeam backup agent jobs.

lastModified

string

Date and time when Veeam backup agent job settings were last modified.

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

isEnabled

boolean

Indicates whether Veeam backup agent is activated.

modifiedBy

string

Account under which Veeam backup agent job settings were last modified.

duration

integer

Time taken to complete the latest Veeam backup agent job session.

durationUnits

string

Measurement units for the latest Veeam backup agent job duration. Has the constant value s.

destinationType

string

Target storage for the backup files.

avgDuration

integer

Average time taken to complete Veeam backup agent job session.

avgDurationUnits

string

Measurement units for average Veeam backup agent job duration. Has the constant value s.

restorePointsCount

integer

Number of restore points to keep for the Veeam backup agent job.

lastRun

string

Date and time when the latest Veeam backup agent job session started.

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

destinationFreeSpace

integer

Free space remaining on a target storage.

destinationFreeSpaceUnits

string

Measurement units for free space remaining on a target storage.

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

status

string

Status of the latest Veeam backup agent job session.

uiMode

string

Veeam backup agent UI mode.

Possible values:

  • Full
  • ReadOnly

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