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

(GET) /agents/agentRestorePoints/{ID}/mounts/{ID}/{filepath}

Returns a resource representation of a file or folder in the guest OS.

Request

To get a specific guest OS file or folder, you need to send the GET HTTP request to the URL of the /agents/agentRestorePoints/{ID}/mounts/{ID}/{filepath} resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/api/agents/agentRestorePoints/{ID}/mounts/{ID}/{filepath}

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

The response body contains links to the file or folder restore action and links that let the client browse the backed up machine file system. Following the links, the client can get a list of all files and folders, a list of files only, a list of folders only as well as can paginate display results.

Example

The example below returns a resource representation for the C:/Users folder in the backed up machine's guest OS:

Request:

GET http://localhost:9399/api/agents/agentRestorePoints/dd3cf3d0-0533-424e-abc3-249c4c62b797/mounts/1/C:/Users

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<FileSystemEntries Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users?action=listAll&pageSize=100&page=1" 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://localhost:9399/api/vmRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:?action=listAll&pageSize=100&page=1" Rel="Up"/>
 </Links>
 <Files>
   <FileEntry Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/desktop.ini" Type="FileEntry">
     <Links>
       <Link Href="http://localhost:9399/api/vmRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users?action=listAll&pageSize=100&page=1" Rel="Up"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/desktop.ini?action=restore" Rel="Restore"/>
     </Links>
     <Path>C:/Users/desktop.ini</Path>
     <Name>desktop.ini</Name>
     <Size>174</Size>
     <ModifiedDateUTC>2016-07-16T13:21:29Z</ModifiedDateUTC>
   </FileEntry>
 </Files>
 <Directories>
   <DirectoryEntry Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Administrator" Type="DirectoryEntry">
     <Links>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users?action=listAll&pageSize=100&page=1" Rel="Up"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Administrator?action=listAll&pageSize=100&page=1" Rel="Down"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Administrator?action=listDirs&pageSize=10&page=1" Rel="Down"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Administrator?action=listFiles&pageSize=10&page=1" Rel="Down"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Administrator?action=restore" Rel="Restore"/>
     </Links>
     <Path>C:/Users/Administrator</Path>
     <Name>Administrator</Name>
   </DirectoryEntry>
   <DirectoryEntry Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/All%20Users" Type="DirectoryEntry">
     <Links>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users?action=listAll&pageSize=100&page=1" Rel="Up"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/All%20Users?action=listAll&pageSize=100&page=1" Rel="Down"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/All%20Users?action=listDirs&pageSize=10&page=1" Rel="Down"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/All%20Users?action=listFiles&pageSize=10&page=1" Rel="Down"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/All%20Users?action=restore" Rel="Restore"/>
     </Links>
     <Path>C:/Users/All Users</Path>
     <Name>All Users</Name>
   </DirectoryEntry>
   <DirectoryEntry Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Default" Type="DirectoryEntry">
     <Links>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users?action=listAll&pageSize=100&page=1" Rel="Up"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Default?action=listAll&pageSize=100&page=1" Rel="Down"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Default?action=listDirs&pageSize=10&page=1" Rel="Down"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Default?action=listFiles&pageSize=10&page=1" Rel="Down"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Default?action=restore" Rel="Restore"/>
     </Links>
     <Path>C:/Users/Default</Path>
     <Name>Default</Name>
   </DirectoryEntry>
   <DirectoryEntry Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Default%20User" Type="DirectoryEntry">
     <Links>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users?action=listAll&pageSize=100&page=1" Rel="Up"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Default%20User?action=listAll&pageSize=100&page=1" Rel="Down"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Default%20User?action=listDirs&pageSize=10&page=1" Rel="Down"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Default%20User?action=listFiles&pageSize=10&page=1" Rel="Down"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Default%20User?action=restore" Rel="Restore"/>
     </Links>
     <Path>C:/Users/Default User</Path>
     <Name>Default User</Name>
   </DirectoryEntry>
   <DirectoryEntry Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Public" Type="DirectoryEntry">
     <Links>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users?action=listAll&pageSize=100&page=1" Rel="Up"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Public?action=listAll&pageSize=100&page=1" Rel="Down"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Public?action=listDirs&pageSize=10&page=1" Rel="Down"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Public?action=listFiles&pageSize=10&page=1" Rel="Down"/>
       <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users/Public?action=restore" Rel="Restore"/>
     </Links>
     <Path>C:/Users/Public</Path>
     <Name>Public</Name>
   </DirectoryEntry>
 </Directories>
 <PagingInfo PageNum="1" PageSize="100" PagesCount="1">
   <Links>
     <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users?action=listAll&pageSize=100&page=1" Rel="First"/>
     <Link Href="http://localhost:9399/api/agents/agentRestorePoints/bffd6a30-170e-4dc5-ad7c-d9ab0dc5fefb/mounts/1/C:/Users?action=listAll&pageSize=100&page=1" Rel="Last"/>
   </Links>
 </PagingInfo>
</FileSystemEntries>

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 Reference

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