GET /replicas/{ID}

In this article

    Returns a resource representation of a replica having the specified ID. The replica is created on the backup server connected to Veeam Backup Enterprise Manager.

    Request

    To get a replica, send the GET HTTP request to the URL of the /replicas/{ID} resource.

    HTTP Request

    GET https://<Enterprise-Manager>:9398/api/replicas/{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 resource, for example: urn:veeam:Replica:58c917c7-7b7a-41ff-8676-226656c35c05.

    True

    True

    Name

    String

    Name of the replica resource, for example: DNS Replication.

    True

    True

    JobUid

    URN

    ID of the replication job parent to the replica, for example:urn:veeam:Job:da736815-4fea-4c8e-b0e1-5ecdbca1c512.

    True

    True

    JobName

    String

    Name of the replication job parent to the replica, for example: DNS Replication.

    True

    True

    RepositoryUid

    URN

    ID of the backup repository in which replica metadata is stored, for example: urn:veeam:Repository:b609c947-dd30-4295-8b57-cc880329dbd6.

    True

    True

    RepositoryName

    Name

    Name of the backup repository in which replica metadata is stored, for example: Backup Vol 1.

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

    Example

    A sample request below returns a replica having ID fe4d9334-8801-440c-9994-5a16181d7fb0.

    Request:

    GET https://localhost:9398/api/replicas/fe4d9334-8801-440c-9994-5a16181d7fb0

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 OK

     

    Response Body:

    <EntityRef xmlns="http://www.veeam.com/ent/v1.0" Type="ReplicaReference" Href="https://localhost:9398/api/replicas/fe4d9334-8801-440c-9994-5a16181d7fb0" Name="SQL Replication" UID="urn:veeam:Replica:fe4d9334-8801-440c-9994-5a16181d7fb0">
     <Links>
       <Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.tech.local" />
       <Link Rel="Up" Type="RepositoryReference" Href="https://localhost:9398/api/repositories/cbd9a4b6-b9ed-4cd6-a091-75b6481c9d55" Name="Default Backup Repository" />
       <Link Rel="Alternate" Type="Replica" Href="https://localhost:9398/api/replicas/fe4d9334-8801-440c-9994-5a16181d7fb0?format=Entity" Name="SQL Replication" />
       <Link Rel="Down" Type="VmReplicaPointReferenceList" Href="https://localhost:9398/api/replicas/fe4d9334-8801-440c-9994-5a16181d7fb0/vmReplicaPoints" />
     </Links>
    </EntityRef>

     

    I want to report a typo

    There is a misspelling right here:

     

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