GET /vmRestorePoints/{ID}/mounts/{ID}/{filepath}

In this article

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

    Request

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

    HTTP Request

    GET https://<Enterprise-Manager>:9398/api/vmRestorePoints/{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. For details, 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.

    Request Body

    None.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns response code 200 OK.

    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 VM 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.

    Parameters

    Element

    Type

    Description

    Files

    FileEntryListType

    Collection of directories that are contained in the the current directory. For details, see Files.

    Directories

    DirectoryEntryListType

    Collection of directories that are contained in the the current directory. For details, see Directories.

    PagingInfo

    PagingInfoType

    Resource that lets you paginate display results.

    Files

    The FileEntry resource contains the following parameters.

    Element

    Type

    Description

    Path

    String

    Path to the file in the VM file system hierarchy, for example: C:\william.fox\Report.docx.

    Name

    String

    Name of the file, for example: Report.docx.

    Size

    Long

    File size, in bytes.

    Owner

    String

    File owner.

    ModifiedDateUTC

    DateTime

    Date and the file was last modified.

    Actions

    LinkListType

    List of request URLs available for the file.

    Directories

    The DirectoryEntry resource contains the following parameters.

    Element

    Type

    Description

    Path

    String

    Path to the directory in the VM file system hierarchy, for example: C:\Shares.

    Name

    String

    Name of the directory, for example: Shares.

    Links

    Reference

    Relationship

    Description

    /vmRestorePoints/{ID}/mounts/{ID}/{filepath}

    Up

    URL of the /vmRestorePoints/{ID}/mounts/{ID}/{filepath} resource — the directory at the higher level of hierarchy that contains the current directory entry.

    /vmRestorePoints/{ID}/mounts/{ID}/{filepath}?action=listAll

    Down

    URL of the /vmRestorePoints/{ID}/mounts/{ID}/{filepath} resource — a collection of directories and files contained in the current directory.

    /vmRestorePoints/{ID}/mounts/{ID}/{filepath}?action=listDirs

    Down

    URL of the /vmRestorePoints/{ID}/mounts/{ID}/{filepath} resource — a collection of directories contained in the current directory.

    /vmRestorePoints/{ID}/mounts/{ID}/{filepath}?action=listFiles

    Down

    URL of the /vmRestorePoints/{ID}/mounts/{ID}/{filepath} resource — a collection of files contained in the current directory.

    /vmRestorePoints/{ID}/mounts/{ID}/{filepath}?action=listAll

    Restore

    URL for the POST /vmReplicaPoints/{ID}/mounts/{ID}/{filepath}?action=restore request.

    Example

    The example below returns a resource representation for the E:/Documentation 2014 folder in the VM guest OS:

    Request:

    GET https://localhost:9398/api/vmRestorePoints/5253146b-a313-4831-9467-03c7e21b32e1/mounts/1/E:/Documentation%2014

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 OK

     

    Response Body:

    <FileSystemEntries xmlns="http://www.veeam.com/ent/v1.0" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014?action=listAll&pageSize=100&page=1">
     <Links>
       <Link Rel="Up" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/?action=listAll&pageSize=100&page=1" />
     </Links>
     <Directories>
       <DirectoryEntry Type="DirectoryEntry" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Contracts">
         <Links>
           <Link Rel="Up" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014?action=listAll&pageSize=100&page=1" />
           <Link Rel="Down" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Contracts?action=listAll&pageSize=100&page=1" />
           <Link Rel="Down" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Contracts?action=listDirs&pageSize=10&page=1" />
           <Link Rel="Down" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Contracts?action=listFiles&pageSize=10&page=1" />
           <Link Rel="Restore" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Contracts?action=restore" />
         </Links>
         <Path>E:/Documentation 2014/Contracts</Path>
         <Name>Contracts</Name>
       </DirectoryEntry>
       <DirectoryEntry Type="DirectoryEntry" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Invoices">
         <Links>
           <Link Rel="Up" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014?action=listAll&pageSize=100&page=1" />
           <Link Rel="Down" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Invoices?action=listAll&pageSize=100&page=1" />
           <Link Rel="Down" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Invoices?action=listDirs&pageSize=10&page=1" />
           <Link Rel="Down" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Invoices?action=listFiles&pageSize=10&page=1" />
           <Link Rel="Restore" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Invoices?action=restore" />
         </Links>
         <Path>E:/Documentation 2014/Invoices</Path>
         <Name>Invoices</Name>
       </DirectoryEntry>
       <DirectoryEntry Type="DirectoryEntry" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Offers">
         <Links>
           <Link Rel="Up" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014?action=listAll&pageSize=100&page=1" />
           <Link Rel="Down" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Offers?action=listAll&pageSize=100&page=1" />
           <Link Rel="Down" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Offers?action=listDirs&pageSize=10&page=1" />
           <Link Rel="Down" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Offers?action=listFiles&pageSize=10&page=1" />
           <Link Rel="Restore" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Offers?action=restore" />
         </Links>
         <Path>E:/Documentation 2014/Offers</Path>
         <Name>Offers</Name>
       </DirectoryEntry>
       <DirectoryEntry Type="DirectoryEntry" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Tax%20Docs">
         <Links>
           <Link Rel="Up" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014?action=listAll&pageSize=100&page=1" />
           <Link Rel="Down" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Tax%20Docs?action=listAll&pageSize=100&page=1" />
           <Link Rel="Down" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Tax%20Docs?action=listDirs&pageSize=10&page=1" />
           <Link Rel="Down" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Tax%20Docs?action=listFiles&pageSize=10&page=1" />
           <Link Rel="Restore" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Tax%20Docs?action=restore" />
         </Links>
         <Path>E:/Documentation 2014/Tax Docs</Path>
         <Name>Tax Docs</Name>
       </DirectoryEntry>
     </Directories>
     <PagingInfo PageNum="1" PageSize="100" PagesCount="1">
       <Links>
         <Link Rel="First" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014?action=listAll&pageSize=100&page=1" />
         <Link Rel="Last" Href="https://localhost:9398/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014?action=listAll&pageSize=100&page=1" />
       </Links>
     </PagingInfo>
    </FileSystemEntries>