GET /cloud/vmReplicaPoints/{ID}

In this article

    Returns a resource representation of a VM replica restore point that has the specified ID. VM is replicated with the tenant replication job.

    Request

    To get a restore point for a specific tenant VM replica, you need to send the GET HTTP request to the URL of the /cloud/vmReplicaPoints/{ID} resource.

    HTTP Request

    GET https://<Enterprise-Manager>:9398/api/cloud/vmReplicaPoints/{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. 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.

    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 VM replica point resource.

    True

    True

    Name

    String

    Name of the VM replica point, for example: dc-hv@2015-12-25 20:03:56.

    True

    True

    CreationTime

    DateTime

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

    True

    True

    VmName

    String

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

    True

    True

    Type

    String

    Type of the VM replica point. Possible values:

    • Full
    • ReverseIncrement
    • Increment
    • Snapshot

    True

    True

    ReplicaUid

    URN

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

    True

    True

    ReplicaName

    String

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

    True

    True

    VmDisplayName

    String

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

    True

    True

    BackupServerUid

    URN

    ID of the backup server on which the account of the tenant who has  created the VM replica restore point had been created.

    True

    True

    BackupServerName

    String

    Name of the backup server on which the account of the tenant who has created the VM replica restore point had been created.

    True

    True

    State

    String

    State of the tenant VM replica. Possible values:

    • Unknown
    • Ready
    • Failover
    • Failback
    • PermanentFailover

    True

    True

    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 /cloud/vmReplicaPoints/{ID} resource.

    Example

    The example below returns an entity resource representation of the VM replica restore point having ID 93081441-6e3c-4584-b47a-08dc1ce24f84:

    Request:

    GET https://localhost:9398/api/vmReplicaPoints/93081441-6e3c-4584-b47a-08dc1ce24f84?format=Entity

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 OK

     

    Response Body:

    <CloudVmReplicaPoint xmlns="http://www.veeam.com/ent/v1.0" Type="CloudVmReplicaPoint" Href="https://localhost:9398/api/cloud/vmReplicaPoints/93081441-6e3c-4584-b47a-08dc1ce24f84?format=Entity" Name="srv39@2015-12-25 20:00:47" UID="urn:veeam:CloudVmReplicaPoint:93081441-6e3c-4584-b47a-08dc1ce24f84" VmDisplayName="srv39">
     <Links>
       <Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/8fff3b8e-c3f1-4ef5-aecc-561f07bf9982" Name="172.17.53.48" />
       <Link Rel="Up" Type="CloudReplicaReference" Href="https://localhost:9398/api/cloud/replicas/6b2b42d5-3850-421c-93c1-e063f12a2ead" Name="UCM Company CRM Replication" />
       <Link Rel="Alternate" Type="CloudVmReplicaPointReference" Href="https://localhost:9398/api/cloud/vmReplicaPoints/93081441-6e3c-4584-b47a-08dc1ce24f84" Name="srv39@2015-12-25 20:00:47" />
     </Links>
     <CreationTimeUTC>2015-12-25T20:00:47Z</CreationTimeUTC>
     <PointType>Snapshot</PointType>
     <State>Ready</State>
    </CloudVmReplicaPoint>

     

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.