Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
RESTful API Reference

(GET) /backups/{ID}

Returns a resource representation of a backup having the specified ID. The backup is created on or imported to the Veeam backup server connected to Veeam Backup Enterprise Manager.

Request

To get a backup, you need to send the GET HTTP request to the URL of the /backups/{ID} resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/api/backups/{ID}

Request Headers

The request contains the following headers:

Header

Required

Description

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

The request requires a certain format in response. In the header, the client can specify one of the following formats:

  • application/xml
  • application/json

Request Body

None.

Query Parameters

The following parameters can be used in queries.

Parameter

Type

Description

Can Be Used for Filtering

Can Be Used for Sorting

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 resources.
  • HyperV — for protected HyperV resources.
  • vCloud — for protected vCloud resources.
  • AgentForLinux — for protected Veeam Agent for Linux resources.
  • AgentForWindows — for protected Veeam Agent for Windows resources.
  • CustomPlatform — for N2W, Nutanix and other custom platform backup resources.

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 an Agent Management job and contains links for child backups.
  • ChildBackup — for backup resources that have links for restore points and parent backups. Represents a backup of a protected machine.

True

True

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 200 Success.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Description

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

Response Body

In the response body, Veeam Backup Enterprise Manager returns a representation of the /backups/{ID} resource.

Example

The example below returns a resource representation of a backup having ID c213fbfa-7b9e-4772-9ddc-3ecbdcc3fc70:

Request:

GET http://localhost:9399/api/backups/c213fbfa-7b9e-4772-9ddc-3ecbdcc3fc70

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<EntityRef UID="urn:veeam:Backup:c213fbfa-7b9e-4772-9ddc-3ecbdcc3fc70" Name="Simple backup_1" Href="http://at-w10x64v1709.qahv1.veeam.local:9399/api/backups/c213fbfa-7b9e-4772-9ddc-3ecbdcc3fc70" Type="BackupReference" xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <Links>
   <Link Href="http://local.host:9399/api/backupServers/8c88c6d6-931f-4044-8c0b-7a0c5f188b00" Name="local.host" Type="BackupServerReference" Rel="Up"/>
   <Link Href="http://local.host:9399/api/repositories/b8832f03-2c9e-4222-8d0b-e43e0c912f93" Name="Scale-out Backup Repository 2" Type="RepositoryReference" Rel="Up"/>
   <Link Href="http://local.host:9399/api/backups/c213fbfa-7b9e-4772-9ddc-3ecbdcc3fc70?format=Entity" Name="Simple backup_1" Type="Backup" Rel="Alternate"/>
   <Link Href="http://local.host:9399/api/backups/c213fbfa-7b9e-4772-9ddc-3ecbdcc3fc70/childbackups" Type="BackupReferenceList" Rel="Up"/>
 </Links>
</EntityRef>

 

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation