Properties

id

String

System ID assigned to a computer in the Veeam Service Provider Console REST API.

hostName

String

Name of a discovered computer.

type

String

Type of a discovered computer OS.

Possible values:

• Unknown
• DomainController
• Server
• Workstation

platformType

String

Type of platform on which a discovered computer runs.

Possible values:

• Unknown

• Windows
• Vmware
• HyperV
• Linux
• Azure
• Amazon
• Other

guestOs

String

Guest OS installed on a discovered computer.

applicationInstalled

String

Application detected on a computer by Veeam Service Provider Console.

connectionStatus

String

Computer connection status.

Possible values:

• Online
• Offline
• Rejected
• Rebooting

connectionAccount

String

Company owner user name that is used to connect Veeam Service Provider Console management agent to a cloud gateway.

lastHeartbeat

String

Date and time when a management agent on a computer sent the latest heartbeat to Veeam Service Provider Console.

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

progress

integer

Percentage of Veeam backup agent deployment progress displayed as a decimal fraction.

ipAddress

String

Computer IP address.

macAddress

String

Computer MAC address.

discoveryTime

String

Date and time of computer discovery.

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

backupAgentInstalled

Boolean

Indicates whether backup agent is installed on a computer.

installationType

String

Indicates installation type of a backup agent.

Possible values:

• Unknown
• Full
• Restricted
• Broken

managementMode

String

Indicates management mode of a backup agent.

Possible values:

• Unknown
• UnManaged
• ManagedByVBR
• ManagedByVAC

vacAgentId

String

System ID assigned to Veeam Service Provider Console management agent.

vacAgentStatus

String

Status of Veeam Service Provider Console management agent.

Possible values:

• Healthy
• Inaccessible
• NotInstalled
• Warning
• Updating
• Error
• Restarting
• Installation
• FailedToUpdate

vacAgentVersion

String

Version of Veeam Service Provider Console management agent.

vacAgentRole

String

Role of Veeam Service Provider Console management agent.

Possible values:

• Master
• Client

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property). Can contain links to backup policies assigned to a computer.

vawAgentStatus

String

Status of Veeam backup agent.

Possible values:

• Healthy
• Warning
• Error
• Unknown

vawAgentVersion

String

Version of Veeam backup agent installed on a discovered computer.

backupSize

integer

Total amount of backed up data.

backupSizeUnits

String

Measurement units for backed up data.

Possible values: B (byte) and its multiples formed with metric prefixes.

activationDate

String

Date and time when Veeam backup agent was activated.

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

licenceType

String

Type of license installed for Veeam backup agent.

Possible values:

• Paid (Standalone)
• Activated
• Free
• Activated (managed by backup server)

nextRun

String

Date and time when the next Veeam backup agent job session starts.

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

scheduleType

String

Type of schedule set for Veeam backup agent jobs.

Possible values:

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

lastModified

String

Date and time when Veeam backup agent job settings were last modified.

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

isEnabled

Boolean

Indicates whether Veeam backup agent is activated.

modifiedBy

String

Account under which Veeam backup agent job settings were last modified.

duration*

integer

Time taken to complete the latest Veeam backup agent job session.

durationUnits*

String

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

destinationType*

String

Target storage for the backup files.

avgDuration*

integer

Average time taken to complete Veeam backup agent job session.

avgDurationUnits*

String

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

restorePointsCount*

integer

Number of restore points to keep for the Veeam backup agent job.

lastRun

String

Date and time when the latest Veeam backup agent job session started.

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

destinationFreeSpace*

integer

Free space remaining on a target storage.

destinationFreeSpaceUnits*

String

Measurement units for free space remaining on a target storage.

Possible values: B (byte) and its multiples formed with metric prefixes.

status*

String

Status of the latest Veeam backup agent job session.

uiMode

String

Veeam backup agent UI mode.

Possible values:

• Na
• Full
• ReadOnly