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

Properties

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

Property

Type

Description

id

integer

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

name

string

Name of the job configured in Veeam Backup & Replication.

status

string

Status of the latest job session.

Possible values:

  • Success
  • Warning
  • Failed
  • Running
  • Idle
  • No Info

type

string

Veeam Backup & Replication job type.

Possible values:

  • Backup
  • Replication
  • SureBackup
  • Backup Copy
  • File to Tape
  • Backup to Tape
  • Copy
  • SQL Log Backup Job
  • Oracle Log Backup Job

lastRun

string

Date and time when the latest job session started.

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

endTime

string

Date and time when the latest job session finished.

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

duration

integer

Time taken to complete the latest job session.

durationUnits

string

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

processingRate

integer

Rate at which VM data was processed during the latest job session.

processingRateUnits

string

Measurement units for the rate at which VM data was processed during the latest job session.

avgDuration

integer

Average time taken to complete a job session.

avgDurationUnits

string

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

transferedData

integer

Total amount of data that was transferred to target during the latest job session.

transferedDataUnits

string

Measurement units for the data that was transferred to target during the latest job session.

bottleneck

string

Bottleneck in the process of transferring the data from source to target.

Possible values:

  • Source
  • Proxy
  • Network
  • Target
  • Source WAN accelerator
  • Target WAN accelerator

serverName

string

Name of the Veeam Backup & Replication or Veeam Cloud Connect server on which a job was configured.

isEnabled

boolean

Indicates whether a job schedule is enabled.

protectedVMs

integer

Number of VMs protected by the job.

schedulingType

string

Type of schedule configured for the job.

Possible values:

  • Continuously
  • Periodically
  • Monthly
  • Daily
  • Chained

actions

Array

Actions performed by the POST method.

Available actions:

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property). Contains a link to the tenant, whose data the job protects.

Veeam Large Logo

Deployment Guide

Migration Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Evaluator's Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Evaluator's Guide for Enterprises

RESTful API Reference