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

(GET) /replicaTaskSessions/{ID}

Returns a resource representation of a task having the specified ID. The parent replication job for the task is created and run on the Veeam backup server connected to Veeam Backup Enterprise Manager.

Request

To get a task having the specified ID, you need to send the GET HTTP request to the URL of the /replicaTaskSessions/{ID} resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/api/replicaTaskSessions/{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 replica task session.

True

True

Name

String

Name of the replica task session, for example: dc-hv@2013-08-25 05:01:09.

True

True

CreationTime

DateTime

Date and time when the replica task session was launched. The parameter accepts only UTC-formatted DateTime values.

True

True

EndTime

DateTime

Date and time when the replica task session was completed. The parameter accepts only UTC-formatted DateTime values.

True

True

State

String

State of the replica task session. Possible values:

  • InProgress
  • Pending
  • Completed

True

True

Result

String

Result of the replica task session. Possible values:

  • Success
  • Warning
  • Failed

True

True

Reason

String

Reason for which the replica task session has been completed with the Warning or Failed result.

True

True

TotalSize

Long

Size of all restore points produced by the corresponding replication job.

True

True

JobSessionUid

URN

ID of the replication job session parent to the replica task session resource.

True

True

JobUid

URN

ID of the replication job parent to the replica task session resource.

True

True

JobName

String

Name of the replication job parent to the replica task session resource.

True

True

BackupServerUid

URN

ID of the backup server on which the corresponding replication job is created.

True

True

BackupServerName  

String

Name of the backup server on which the corresponding replication job is created.

True

True

VmDisplayName  

String

Name of the VM that is processed in the replica task session.

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

Example

The example request below returns a resource representation of a task having ID 4a212394-ea3b-420d-b1d0-04dbf9f6c622:

Request:

GET http://localhost:9399/api/replicaTaskSessions/4a212394-ea3b-420d-b1d0-04dbf9f6c622

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<EntityRef xmlns="http://www.veeam.com/ent/v1.0" Type="ReplicaTaskSessionReference" Href="http://localhost:9399/api/repicaTaskSessions/24590151-20cd-4e57-8a2f-8b65869a1879" Name="srv04@2014-10-19 06:47:21" UID="urn:veeam:ReplicaTaskSession:24590151-20cd-4e57-8a2f-8b65869a1879">
 <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="ReplicaJobSessionReference" Href="http://localhost:9399/api/replicaSessions/2c49a44e-1e59-4527-a6bc-6b2f9b579ee1" Name="Fileserver02 Replication" />
   <Link Rel="Alternate" Type="ReplicaTaskSession" Href="http://localhost:9399/api/repicaTaskSessions/24590151-20cd-4e57-8a2f-8b65869a1879?format=Entity" Name="srv04@2014-10-19 06:47:21" />
 </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