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

(GET) /cloud/cloudFailoverPlans

Returns a resource representation of a collection of all cloud failover plans configured by tenants on Veeam backup servers that are connected to Veeam Backup Enterprise Manager.

Request

To get a list of cloud failover plans configured by tenants on Veeam backup servers, you need to send the GET HTTP request to the URL of the /cloud/cloudFailoverPlans resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/api/cloud/cloudFailoverPlans

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 /cloud/cloudFailoverPlans resource collection.

Example

The example below returns a list of all cloud failover plans configured by tenants on Veeam backup servers managed by Veeam Backup Enterprise Manager.

Request:

GET http://localhost:9399/api/cloud/cloudFailoverPlans

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<EntityReferences xmlns="http://www.veeam.com/ent/v1.0">
 <Ref Type="FailoverPlanReference" Href="http://localhost:9399/api/managedServers/e7ca6822-a87f-443d-8aae-8005970543bf" Name="ABC Company Failover Plan" UID="urn:veeam:FailoverPlan:e7ca6822-a87f-443d-8aae-8005970543bf">
   <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="CloudFailoverPlan" Href="http://localhost:9399/api/cloud/cloudFailoverPlans/e7ca6822-a87f-443d-8aae-8005970543bf?format=Entity" Name="ABC Company Failover Plan" />
     <Link Rel="Related" Type="CloudTenant" Href="http://localhost:9399/api/cloud/tenants/b25f5f1d-a3c3-45ed-af23-9ef31a94dac7?format=Entity" Name="ABC Company" />
   </Links>
 </Ref>
 <Ref Type="FailoverPlanReference" Href="http://localhost:9399/api/managedServers/08d5bbf5-619b-4bb9-ba51-95f4678544f4" Name="UCM Company Full SIte Failover" UID="urn:veeam:FailoverPlan:08d5bbf5-619b-4bb9-ba51-95f4678544f4">
   <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="CloudFailoverPlan" Href="http://localhost:9399/api/cloud/cloudFailoverPlans/08d5bbf5-619b-4bb9-ba51-95f4678544f4?format=Entity" Name="UCM Company Full SIte Failover" />
     <Link Rel="Related" Type="CloudTenant" Href="http://localhost:9399/api/cloud/tenants/4e507777-8349-4683-9336-5fd1ecc27ea6?format=Entity" Name="UCM Company" />
   </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 Endpoint Backup Documentation

Veeam Management Pack Documentation