This is an archive version of the document. To get the most up-to-date information, see the current version.

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 the Veeam Service Provider Console REST 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 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 Quick Migration SAN Rescan Failover Plan Agent Backup Job (Managed by Agent) Agent Backup Job (Managed by Backup Server) Agent Backup Policy Agent Backup Job Windows Agent Backup Copy
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. Possible values: B/s (bytes per second) and its multiples formed with metric prefixes.
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. Possible values: B (byte) and its multiples formed with metric prefixes.
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
companyId	integer	System ID assigned to a company in the Veeam Service Provider Console REST API.
locationId	integer	System ID assigned to a company location in the Veeam Service Provider Console REST API.
actions	Array	Actions performed by the POST method. Available actions: stop retry enable disable start
_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.