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

(GET) /replicaSessions

Returns a resource representation of a collection of all replication job sessions performed on all Veeam backup servers connected to Veeam Backup Enterprise Manager.


To get a list of all sessions for replication job, you need to send the GET HTTP request to the URL of the /replicaSessions resource.

HTTP Request

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

Request Headers

The request contains the following headers:






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.



The request requires a certain format in response. In the header, the client can specify one of the following formats:

  • application/xml
  • application/json

Request Body


Query Parameters



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.




The length of the response body.


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 /replicaSessions resource.


The example below returns a list of sessions for replication jobs on all Veeam backup servers connected to Veeam Backup Enterprise Manager.


GET http://localhost:9399/api/replicaSessions


Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj



200 Success


Response Body:

<EntityReferences xmlns="">
 <Ref Type="ReplicaJobSessionReference" Href="http://localhost:9399/api/replicaSessions/53d58f4f-3976-47b7-aec4-3d29a963b0e5" Name="SQL Replication@2014-10-19 05:41:52" UID="urn:veeam:ReplicaJobSession:53d58f4f-3976-47b7-aec4-3d29a963b0e5">
     <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
     <Link Rel="Up" Type="JobReference" Href="http://localhost:9399/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac" Name="SQL Replication" />
     <Link Rel="Alternate" Type="ReplicaJobSession" Href="http://localhost:9399/api/replicaSessions/53d58f4f-3976-47b7-aec4-3d29a963b0e5?format=Entity" Name="SQL Replication@2014-10-19 05:41:52" />
     <Link Rel="Down" Type="ReplicaTaskSessionReferenceList" Href="http://localhost:9399/api/replicaSessions/53d58f4f-3976-47b7-aec4-3d29a963b0e5/repicaTaskSessions" />
 <Ref Type="ReplicaJobSessionReference" Href="http://localhost:9399/api/replicaSessions/0bcf5a1e-866c-4b40-8bc3-ce64753b9a6b" Name="Fileserver02 Replication@2014-10-19 06:46:31" UID="urn:veeam:ReplicaJobSession:0bcf5a1e-866c-4b40-8bc3-ce64753b9a6b">
     <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
     <Link Rel="Up" Type="JobReference" Href="http://localhost:9399/api/jobs/2c49a44e-1e59-4527-a6bc-6b2f9b579ee1" Name="Fileserver02 Replication" />
     <Link Rel="Alternate" Type="ReplicaJobSession" Href="http://localhost:9399/api/replicaSessions/0bcf5a1e-866c-4b40-8bc3-ce64753b9a6b?format=Entity" Name="Fileserver02 Replication@2014-10-19 06:46:31" />
     <Link Rel="Down" Type="ReplicaTaskSessionReferenceList" Href="http://localhost:9399/api/replicaSessions/0bcf5a1e-866c-4b40-8bc3-ce64753b9a6b/repicaTaskSessions" />


Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation