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

(GET) /replicas/{ID}

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

Request

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

HTTP Request

GET http://<Enterprise-Manager>:9399/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. To learn more, see Authentication and Security.

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 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: application/xml.

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 http://localhost:9399/api/replicas/fe4d9334-8801-440c-9994-5a16181d7fb0

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

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

 

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation