GET /query?type=VmReplicaPoint

In this article

    Returns a resource representation of a collection of restore points for separate replicated VMs. For details, see /vmReplicaPoints.

    Request

    To get a list of restore points for separate replicated VMs, send the GET HTTP request to the query with the type parameter set to VmReplicaPoint.

    HTTP Request

    GET https://<Enterprise-Manager>:9398/api/query?type=VmReplicaPoint

    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.

    Optional Parameters

    In the query, you can use the following parameters for filtering and sorting.

    Parameter

    Type

    Description

    Uid

    URN

    ID of the VM replica point resource.

    Name

    String

    Name of the VM replica point, for example: dc-hv@2014-08-21 11:03:38.

    CreationTime

    DateTime

    Date and time when the restore point was created. The parameter accepts only UTC-formatted DateTime values.

    Type

    String

    Type of the VM replica point. Possible values:

    • Full
    • ReverseIncrement
    • Increment
    • Snapshot

    Algorithm

    String

    Replication method used to create the restore point. Possible values:

    • Full
    • ReversedIncremental
    • Incremental
    • SyntheticFull

    ReplicaUid

    URN

    ID of the VM replica parent to the VM replica point resource.

    ReplicaName

    String

    Name of the VM replica parent to the VM replica point resource.

    VmDisplayName

    String

    Name of the VM for which the restore point has been created.

    BackupServerUid

    URN

    ID of the backup server on which the VM replica restore point has been created.

    BackupServerName

    String

    Name of the backup server on which the VM replica restore point has been created.

    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

    In the response body, Veeam Backup Enterprise Manager returns a representation of the /vmReplicaPoints resource collection.

    Example

    The example below returns an entity resource representation of a collection of restore points created for replicated VM ubuntu88. The results are ordered in the descending order by the CreationTime parameter.

    Request:

    GET https://localhost:9398/web/#/api/query?type=VmReplicaPoint&format=Entities&sortDesc=CreationTime&filter=VmDisplayName==ubuntu88

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 OK

     

    Response Body:

    <QueryResult xmlns="http://www.veeam.com/ent/v1.0">
     <Entities>
       <VmReplicaPoints>
         <VmReplicaPoint Type="VmReplicaPoint" Href="https://localhost:9398/api/vmReplicaPoints/81aba862-b29c-4269-8dfe-70ad4cab7004?format=Entity" Name="ubuntu88@2021-06-16 20:00:39" VmDisplayName="ubuntu88" UID="urn:veeam:VmReplicaPoint:81aba862-b29c-4269-8dfe-70ad4cab7004">
           <Links>
             <Link Rel="Failover" Href="https://localhost:9398/api/vmReplicaPoints/81aba862-b29c-4269-8dfe-70ad4cab7004?action=failover" />
             <Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563" Name="enterprise06.tech.local" />
             <Link Rel="Up" Type="ReplicaReference" Href="https://localhost:9398/api/replicas/47faaa53-9d8b-4512-b60e-d91e8e5ffb63" Name="Replication Job 1" />
             <Link Rel="Alternate" Type="VmReplicaPointReference" Href="https://localhost:9398/api/vmReplicaPoints/81aba862-b29c-4269-8dfe-70ad4cab7004" Name="ubuntu88@2021-06-16 20:00:39" />
             <Link Rel="Down" Type="VmReplicaPointMountList" Href="https://localhost:9398/api/vmReplicaPoints/81aba862-b29c-4269-8dfe-70ad4cab7004/mounts" />
             <Link Rel="Create" Type="VmReplicaPointMount" Href="https://localhost:9398/api/vmReplicaPoints/81aba862-b29c-4269-8dfe-70ad4cab7004/mounts" />
           </Links>
           <CreationTimeUTC>2021-06-16T20:00:39.707Z</CreationTimeUTC>
           <VmName>ubuntu88</VmName>
           <Algorithm>Full</Algorithm>
           <PointType>Snapshot</PointType>
         </VmReplicaPoint>
         <VmReplicaPoint Type="VmReplicaPoint" Href="https://localhost:9398/api/vmReplicaPoints/d529e31d-cedd-496a-9c1f-8662223e7582?format=Entity" Name="ubuntu88@2021-06-15 22:07:32" VmDisplayName="ubuntu88" UID="urn:veeam:VmReplicaPoint:d529e31d-cedd-496a-9c1f-8662223e7582">
           <Links>
             <Link Rel="Failover" Href="https://localhost:9398/api/vmReplicaPoints/d529e31d-cedd-496a-9c1f-8662223e7582?action=failover" />
             <Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563" Name="enterprise06.tech.local" />
             <Link Rel="Up" Type="ReplicaReference" Href="https://localhost:9398/api/replicas/47faaa53-9d8b-4512-b60e-d91e8e5ffb63" Name="Replication Job 1" />
             <Link Rel="Alternate" Type="VmReplicaPointReference" Href="https://localhost:9398/api/vmReplicaPoints/d529e31d-cedd-496a-9c1f-8662223e7582" Name="ubuntu88@2021-06-15 22:07:32" />
             <Link Rel="Down" Type="VmReplicaPointMountList" Href="https://localhost:9398/api/vmReplicaPoints/d529e31d-cedd-496a-9c1f-8662223e7582/mounts" />
             <Link Rel="Create" Type="VmReplicaPointMount" Href="https://localhost:9398/api/vmReplicaPoints/d529e31d-cedd-496a-9c1f-8662223e7582/mounts" />
           </Links>
           <CreationTimeUTC>2021-06-15T22:07:32.45Z</CreationTimeUTC>
           <VmName>ubuntu88</VmName>
           <Algorithm>Full</Algorithm>
           <PointType>Snapshot</PointType>
         </VmReplicaPoint>
       </VmReplicaPoints>
     </Entities>
     <PagingInfo PagesCount="1" PageSize="100" PageNum="1">
       <Links>
         <Link Rel="First" Href="https://localhost:9398/api/query?type=VmReplicaPoint&format=Entities&sortDesc=CreationTime&filter=VmDisplayName==ubuntu88&pageSize=100&page=1" />
         <Link Rel="Last" Href="https://localhost:9398/api/query?type=VmReplicaPoint&format=Entities&sortDesc=CreationTime&filter=VmDisplayName==ubuntu88&pageSize=100&page=1" />
       </Links>
     </PagingInfo>
    </QueryResult>