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 /backupAgents collection have a number of properties that reflect Veeam backup agent 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 Veeam backup agent. |
scheduleDisabled | Boolean | Indicates whether a Veeam backup agent job is scheduled. |
companyId | integer | System ID assigned to a company to which a managed computer belongs. |
locationId | integer | System ID assigned to a location to which a managed computer belongs. |
name | String | Name of a managed computer. |
successJobsCount | integer | Number of successful jobs. |
totalJobsCount | integer | Number of all jobs. |
successfulPercentage | integer | Number of successful jobs relative to all jobs, in percents. |
guiMode | String | Indicates the UI access mode for the Veeam backup agent. Possible values:
|
isViewModeChanging | Boolean | Indicates whether UI access mode is being changed at the moment. |
vawPlatform | String | Backup agent platform. Possible values:
|
cloudCopy | Boolean | Indicates whether a job stores files in cloud repository. |
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. |
backupMode | array | Backup operation mode Possible values:
|
operationMode | String | Indicates the operation mode of a backup agent. Possible values:
|
multijobSupport | Boolean | Indicates whether an agent supports multiple jobs. |
version | String | Version of Veeam backup agent deployed on a managed computer. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
