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

(GET) /replicas

Returns a resource representation of a collection of replicas created on all Veeam backup servers connected to Veeam Backup Enterprise Manager.

Request

To get a list of replicas, you need to send the GET HTTP request to the URL of the /replicas resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/api/replicas

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

None.

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 resource collection.

Example

The example below returns a list of all replicas created on Veeam backup servers connected to Veeam Backup Enterprise Manager.

Request:

GET http://localhost:9399/api/replicas

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<EntityReferences xmlns="http://www.veeam.com/ent/v1.0">
 <Ref Type="ReplicaReference" Href="http://localhost:9399/api/replicas/6a725c36-7426-42df-a887-1ed7b88411d9" Name="replica 1" UID="urn:veeam:Replica:6a725c36-7426-42df-a887-1ed7b88411d9">
   <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/bffeb9f5-1bdd-4bbd-9299-6fcb7c37bdf6" Name="Backup Volume 01" />
     <Link Rel="Alternate" Type="Replica" Href="http://localhost:9399/api/replicas/6a725c36-7426-42df-a887-1ed7b88411d9?format=Entity" Name="Oracle Replica" />
     <Link Rel="Down" Type="VmReplicaPointReferenceList" Href="http://localhost:9399/api/replicas/6a725c36-7426-42df-a887-1ed7b88411d9/vmReplicaPoints" />
   </Links>
 </Ref>
 <Ref 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="AD Replication" />
     <Link Rel="Down" Type="VmReplicaPointReferenceList" Href="http://localhost:9399/api/replicas/fe4d9334-8801-440c-9994-5a16181d7fb0/vmReplicaPoints" />
   </Links>
 </Ref>
 <Ref Type="ReplicaReference" Href="http://localhost:9399/api/replicas/b745edde-cbde-4a74-b7a7-6d2f461c9287" Name="SQL Server Replication" UID="urn:veeam:Replica:b745edde-cbde-4a74-b7a7-6d2f461c9287">
   <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/b745edde-cbde-4a74-b7a7-6d2f461c9287?format=Entity" Name="SQL Server Replication" />
     <Link Rel="Down" Type="VmReplicaPointReferenceList" Href="http://localhost:9399/api/replicas/b745edde-cbde-4a74-b7a7-6d2f461c9287/vmReplicaPoints" />
   </Links>
 </Ref>
</EntityReferences>

 

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 Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation