This is an archive version of the document. To get the most up-to-date information, see the current version.Fail Back to Source VMs
[Applies only to replica plans]
You can start the replica failback process for a plan with the specified ID.
Request
To switch from VM replicas back to original VMs, send the HTTP POST request to the /Plans/{planId}/FailbackToProduction endpoint.
HTTP Request
POST https://<hostname>:<port>/api/v3/Plans/{planId}/FailbackToProduction |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Content-Type | Required | application/json | Identifies a media type that is used in the body of the request. |
Accept | Optional |
| Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request Body
To perform a failback operation, you must send the following specific parameters:
Parameter | Type | Description |
|---|---|---|
restoreLocationId | string | Defines a restore recovery location to be used to perform the failback operation. |
failbackRestoreVMTags | boolean | Defines whether tags of the original VMs will be assigned to the restored VMs. |
In the request body, specify parameters values.
{ "restoreLocationId": "00000000-0000-0000-0000-000000000000", "failbackRestoreVMTags": true/false } |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns 200 response code.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Value | Description |
|---|---|---|
Content-Length | integer | Identifies the length of the response body message, in bytes. |
Content-Type |
| Identifies the media type of the response body message. |
Example
The following example performs failback for a plan with the ID b8517d70-028d-4740-a130-787e164a3d83 to a restore recovery location with the ID ad19ae02-2760-4b38-acee-e1d459b97555 and assigns tags of the original VMs to the restored VMs.
|