This is an archive version of the document. To get the most up-to-date information, see the current version.BackupAgentJob
Property | Type | Attributes | Description |
|---|---|---|---|
instanceUid | String (uuid) | Read-only | UID assigned to a Veeam backup agent job. |
backupAgentUid | String (uuid) | Read-only | UID assigned to a Veeam backup agent. |
organizationUid | String (uuid) | Read-only | UID assigned to an organization. |
name | String | Read-only, nullable | Name of a Veeam backup agent job. |
configUid | String (uuid) | Read-only | UID assigned to a backup job configuration. |
backupPolicyUid | String (uuid) | Read-only, nullable | UID of a backup policy assigned to a Veeam backup agent. |
backupPolicyFailureMessage | String | Read-only, nullable | Message that is displayed in case a backup policy job fails. |
status | String | — | Status of the latest job session. Can be changed to Running or Stopping using the PATCH endpoint. Possible values:
|
operationMode | String | Read-only | Operation mode of a Veeam backup agent. Possible values:
|
destination | String | Read-only, nullable | Location where backup files for a Veeam backup agent reside. |
restorePoints | Integer (int32) | Read-only, nullable | Number of restore points. |
lastRun | String (date-time) | Read-only, nullable | Date and time when the latest job session started. Date and time string is formatted in accordance with RFC 3339. |
lastEndTime | String (date-time) | Read-only, nullable | Date and time when the latest job session finished. Date and time string is formatted in accordance with RFC 3339. |
lastDuration | Integer (int32) | Read-only, nullable | Duration of the latest backup job session, in seconds. |
nextRun | String (date-time) | Read-only, nullable | Date and time of the next scheduled backup job session. Date and time string is formatted in accordance with RFC 3339. |
avgDuration | Integer (int32) | Read-only, nullable | Average duration of a backup job session, in seconds. |
backupMode | String | Read-only | Type of backup operation mode. Possible values:
|
targetType | String | Read-only | Type of a location where backup files for a Veeam backup agent reside. Possible values:
|
isEnabled | Boolean | Read-only | Indicates whether a job schedule is enabled. |
scheduleType | String | Read-only | Type of schedule configured for the job. Possible values:
|
scheduleEvents | Array of strings | Read-only | Events that trigger the backup job launch. |
lastModifiedDate | String (date-time) | Read-only, nullable | Date and time when settings of the backup job were last modified. Date and time string is formatted in accordance with RFC 3339. |
lastModifiedBy | String | Read-only, nullable | Name of the user who last modified job settings. |
failureMessage | String | Read-only, nullable | Message that is displayed in case a backup job fails. |
backedUpSize | Integer (int64) | Read-only, nullable | Total size of all restore points. |