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

(GET) /cloud/failoverSessions/{ID}

Returns a cloud failover session that has the specified ID.

Request

To get a cloud failover session with the specified ID, you need to send the GET HTTP request to the URL of the /cloud/failoverSessions/{ID} resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/api/cloud/failoverSessions/{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 cloud failover session resource, for example: 475420ee-d045-4493-9869-0a970e08f6f9.

True

True

Name

String

Name of the cloud failover session resource, for example: ABC Company Failover Plan.

True

True

Type

String

Type of the cloud failover session. Possible value: FailoverPlan.

True

True

CreationTime

DateTime

Date and time when the cloud failover session was started. The parameter accepts only UTC-formatted DateTime values.

True

True

EndTime

DateTime

Date and time when the cloud failover session was ended. The parameter accepts only UTC-formatted DateTime values

True

True

State

String

State of the cloud failover session. Possible values:

  • Starting
  • Stopping
  • Working
  • Stopped

True

True

Result

String

Result of the cloud failover session. Possible values:

  • Success
  • Warning
  • Failed

True

True

FailureMessage

String

 

True

True

BackupServerUid

URN

ID of the Veeam backup server parent to the cloud failover session resource.

True

True

BackupServerName

String

Name of the Veeam backup server parent to the cloud failover session resource.

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

Example

The example below returns a cloud failover session performed in Veeam Backup & Replication. The cloud failover session has ID 475420ee-d045-4493-9869-0a970e08f6f9.

Request:

GET http://localhost:9399/api/cloud/failoverSessions/475420ee-d045-4493-9869-0a970e08f6f9

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<EntityRef xmlns="http://www.veeam.com/ent/v1.0" Type="CloudFailoverSessionReference" Href="http://localhost:9399/api/cloud/failoverSessions/475420ee-d045-4493-9869-0a970e08f6f9" Name="ABC Company Failover Plan" UID="urn:veeam:CloudFailoverSession:475420ee-d045-4493-9869-0a970e08f6f9">
 <Links>
   <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/8fff3b8e-c3f1-4ef5-aecc-561f07bf9982" Name="172.17.53.48" />
   <Link Rel="Alternate" Type="CloudFailoverSession" Href="http://localhost:9399/api/cloud/failoverSessions/475420ee-d045-4493-9869-0a970e08f6f9?format=Entity" Name="ABC Company Failover Plan" />
 </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 Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation