(GET) /backups/{ID}

X-RestSvcSessionId

True

The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security.

Accept

False

Identifies the format of the response. Possible values:

• application/xml — the client can send this value in the header to accept response in the XML format.
• application/json — the client must send this value in the header to accept the request in the JSON format.

If the request does not contain the header, the server will return the response in the XML format.

Uid

URN

ID of the backup resource, for example: urn:veeam:Backup:58c917c7-7b7a-41ff-8676-226656c35c05.

True

True

Name

String

Name of the backup job parent to the backup, for example: SQL Backup.

True

True

JobUid

URN

ID of the backup job parent to the backup, for example:urn:veeam:Job:da736815-4fea-4c8e-b0e1-5ecdbca1c512.

True

True

JobName

String

Name of the backup job parent to the backup, for example: DNS Backup.

True

True

RepositoryUid

URN

ID of the backup repository parent to the backup, for example: urn:veeam:Repository:b609c947-dd30-4295-8b57-cc880329dbd6.

True

True

RepositoryName

Name

Name of the backup repository parent to the backup, for example: Backup Vol 1.

True

True

Platform

String

Type of a platform of a backup resource. Possible values:

• VMware — for protected VMware vSphere VMs.
• HyperV — for protected Microsoft Hyper-V VMs.
• vCloud — for protected vCloud Director resources.
• AgentForLinux — for machines protected with Veeam Agent for Linux.
• AgentForWindows — for machines protected with Veeam Agent for Windows.
• CustomPlatform — for Nutanix and other custom platforms.

True

True

BackupType

String

Type of a backup resource. Possible values:

• Standard — for VMware, HyperV, vCloud and Standalone Veeam Backup Agent backup resources.
• ParentBackup — for backup container resources. Represents a backup created by a Veeam Agent backup job in the Veeam Agent Management scenario, and contains links for child backups.
• ChildBackup — for backup resources that have links to restore points and parent backups. Represents a backup of a separate machine in the backup created by a Veeam Agent backup job in the Veeam Agent Management scenario.

True

True

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message. Possible values:

• application/xml
• application/json