This is an archive version of the document. To get the most up-to-date information, see the current version.

(GET) /cloud/cloudFailoverPlans/{ID}

On This Page

Request
Response
Example

Returns a resource representation of the cloud failover plan that has the specified ID.

Request

To get a resource representation of the cloud failover plan, you need to send the GET HTTP request to the URL of the /cloud/cloudFailoverPlans/{ID} resource:

HTTP Request

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

GET http://<Enterprise-Manager>:9399/api/cloud/cloudFailoverPlans/{ID}?format=Entity

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 failover plan, for example: urn:veeam:FailoverPlan:ae01e36f-32a3-4095-95fa-09a2af744009.	True	True
Name	String	Name of the failover plan, for example: SQL Failover Plan.	True	True
Description	String	Description of the failover plan specified at the time of the failover plan creation.	True	True
CloudTenantUid	URN	ID of the cloud tenant account, for example: urn:veeam:CloudTenant:4f90635a-7ecc-49fe-beb6-60b37eb4bd89	True	True
CloudTenantName	String	Name or the cloud tenant account, for example: Cloud Tenant.	True	True
BackupServerUid	URN	ID of the Veeam backup server parent to the failover plan resource.	True	True
BackupServerName	String	Name of the Veeam backup server parent to the failover plan 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/cloudFailoverPlans/{ID} resource.

Example

The example below returns an entity reference representation of the cloud failover plan that has ID e7ca6822-a87f-443d-8aae-8005970543bf:

Request:

GET http://localhost:9399/api/cloud/cloudFailoverPlans/e7ca6822-a87f-443d-8aae-8005970543bf

Request Header:

X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

Response:

200 Success

Response Body: