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

Properties

The resources in the /backupAgents/{id}/jobs collection have a number of properties that reflect backup agent job settings. 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 job or policy.

If Veeam Agent for Windows version is 2.2 or earlier, this property has the 00000000-0000-0000-0000-000000000000 value.

lastSessionStatus

string

Status of the latest job session.

Possible values:

  • Unknown
  • None
  • Success
  • Warning
  • Failed
  • Running

name

string

Name of an assigned policy or job.

description

string

Description of a job.

operationMode

string

Indicates the operation mode of a backup agent.

Possible values:

  • UnLicensed
  • Server
  • Workstation

destination

string

Location where backup files for a Veeam backup agent reside.

restorePoints

integer

Number of restore points. If a job has never been started, returns 0.

lastRestorePoint

string

Date and time when the last restore point was created.

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

backupSize

integer

Total size of all restore points. If a job has never been started, returns 0.

scheduleType

string

Type of job schedulling.

Possible values:

  • NotScheduled
  • Unknown
  • Daily
  • Monthly
  • Periodically
  • Continuously

lastRun

string

Date and time when the latest backup job session started.

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

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.

nextRun

string

Date and time of the next backup job session according to the backup schedule.

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

freeSpace

integer

Amount of free space available on the target repository. If a job has never been started, returns 0.

avgDuration

integer

Average duration of a backup job session.

lastDuration

integer

Duration of the latest backup job session.

backupMode

string

Type of backup operation mode.

Possible values:

  • Unknown
  • EntireComputer
  • Volume
  • Folder

targetType

string

Type of a location where backup files for a Veeam backup agent reside

Possible values:

  • Unknown
  • Local
  • Cloud

disabled

boolean

Indicates whether the Veeam backup agent job is disabled.

failureMessage

string

Message that is displayed in case backup job fails.

backupPolicyNote

string

Message that is displayed when backup policy is assigned.

cloudConnectAgentUid

string

System ID assigned to a management agent that is installed on the service provider backup server.

backupPolicyId

integer

System ID of a backup policy assigned to a Veeam backup agent.

If the job is custom, returns 0.

backupPolicyName

string

Name of a backup policy assigned to a Veeam backup agent.

backupPolicyStatus

string

Status of a backup policy.

Possible values:

  • Na
  • Assigned
  • Unassigned
  • Custom
  • Outdated
  • Applying
  • FailedToApply
  • Warning
  • Deleting

_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