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

(GET) /agents/agentRestorePoints

Returns a resource representation of a collection of restore points for separate Agent protected machines in backup files.

Request

To get a list of restore points for separate Agent protected machines, you need to send the GET HTTP request to the URL of the /agents/agentRestorePoints resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/api/agents/agentRestorePoints

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

None.

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 /agents/agentRestorePoints resource collection.

Example

The example below returns a list of all restore points for Agent Management backups on Veeam backup servers connected to Veeam Backup Enterprise Manager.

Request:

GET http://localhost:9399/api/agents/agentRestorePoints

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<EntityReferences 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">
 <Ref UID="urn:veeam:AgentRestorePoint:f7807556-1001-4875-9736-02fff650ca22" Name="vcpsql12ten.local@2018-12-18 03:02:29" Href="http://local.host:9399/api/agents/agentRestorePoints/f7807556-1001-4875-9736-02fff650ca22" Type="AgentRestorePointReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/3e1e451a-4718-4475-836b-9547ccae6872" Name="local.host" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/restorePoints/7a783889-61d4-4ccb-8ea4-dce7ff2799ce" Name="Dec 18 2018  3:01AM" Type="RestorePointReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backupFiles/06bc03eb-a6cd-4bb5-8cde-eec6da37ab79" Name="Agent Backup Job SQL - vcpsql12ten.veea_7500D2018-12-18T060109.vib" Type="BackupFileReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/agents/agentRestorePoints/f7807556-1001-4875-9736-02fff650ca22?format=Entity" Name="vcpsql12ten.local@2018-12-18 03:02:29" Type="AgentRestorePoint" Rel="Alternate"/>
   </Links>
 </Ref>
 <Ref UID="urn:veeam:AgentRestorePoint:0b64039c-cc71-49d1-bb17-03aac684195b" Name="vcpsql12ten.local@2018-12-16 01:01:09" Href="http://local.host:9399/api/agents/agentRestorePoints/0b64039c-cc71-49d1-bb17-03aac684195b" Type="AgentRestorePointReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/3e1e451a-4718-4475-836b-9547ccae6872" Name="local.host" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/restorePoints/96d06451-e3f8-4e84-a654-8d8cde618994" Name="Dec 16 2018  1:00AM" Type="RestorePointReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backupFiles/21b6dffe-ff1f-4fc6-98ce-263640531154" Name="Agent Backup Job SQL - vcpsql12ten.veea_EBB8D2018-12-16T040044.vib" Type="BackupFileReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/agents/agentRestorePoints/0b64039c-cc71-49d1-bb17-03aac684195b?format=Entity" Name="vcpsql12ten.local@2018-12-16 01:01:09" Type="AgentRestorePoint" Rel="Alternate"/>
   </Links>
 </Ref>
 <Ref UID="urn:veeam:AgentRestorePoint:117fe4ab-33ff-4254-900b-084d5c7b1afb" Name="vcpsql12ten.local@2018-12-19 05:02:56" Href="http://local.host:9399/api/agents/agentRestorePoints/117fe4ab-33ff-4254-900b-084d5c7b1afb" Type="AgentRestorePointReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/3e1e451a-4718-4475-836b-9547ccae6872" Name="local.host" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/restorePoints/711adce7-ef22-4c5f-92f6-37aa9b9644ec" Name="Dec 19 2018  5:01AM" Type="RestorePointReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backupFiles/bc20e231-6b3b-4c1e-ab87-a776e7cd4dcb" Name="Agent Backup Job SQL - vcpsql12ten.veea_2FD2D2018-12-19T080119.vib" Type="BackupFileReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/agents/agentRestorePoints/117fe4ab-33ff-4254-900b-084d5c7b1afb?format=Entity" Name="vcpsql12ten.local@2018-12-19 05:02:56" Type="AgentRestorePoint" Rel="Alternate"/>
   </Links>
 </Ref>
 <Ref UID="urn:veeam:AgentRestorePoint:90e83c3f-4d9c-4596-b745-09a7657f1157" Name="vcpsql12ten.local@2018-12-17 21:02:25" Href="http://local.host:9399/api/agents/agentRestorePoints/90e83c3f-4d9c-4596-b745-09a7657f1157" Type="AgentRestorePointReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/3e1e451a-4718-4475-836b-9547ccae6872" Name="local.host" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/restorePoints/44a8ccd8-ddb7-454c-8210-21c238c0dbe4" Name="Dec 17 2018  9:01PM" Type="RestorePointReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backupFiles/a222e9e6-155b-4f71-bfa3-8740470da8d5" Name="Agent Backup Job SQL - vcpsql12ten.veea_4224D2018-12-18T000110.vib" Type="BackupFileReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/agents/agentRestorePoints/90e83c3f-4d9c-4596-b745-09a7657f1157?format=Entity" Name="vcpsql12ten.local@2018-12-17 21:02:25" Type="AgentRestorePoint" Rel="Alternate"/>
   </Links>
 </Ref>
 ...
</EntityReferences>

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