Veeam Backup & Replication 13
REST API Reference
Related documents

Failback

The Failback section defines paths and operations for managing failback.

Start Failback

The HTTP POST request to the /api/v1/failback/failbackToProduction/vSphere/snapshot path allows you to fail back from snapshot replicas to production VMware vSphere VMs.

Failback must be finalized. After you have switched over to production VMs (automatically or manually), do one of the following:

  • If a production VM works as expected, commit failback for the VM.
  • If a production VM does not work as expected, undo failback for the VM.

Available to: Veeam Backup Administrator, Veeam Restore Operator.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.3-rev0

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Request Body schema: application/json
required
type
required
string (EReplicaFailbackType)

Failback type.

  • OriginalLocation — Failback to the original VM that resides in the original location
  • OriginalVM — Failback to the original VM that was restored to a different location
  • Customized — Failback to a custom location

replicaPointIds
Array of strings <uuid>

Array of replica restore points that you want to fail back from.

drSiteProxyId
Array of strings <uuid>

Array of backup proxies in the disaster recovery site.

productionSiteProxyId
Array of strings <uuid>

Array of backup proxies in the production site.

powerOnTargetVM
boolean

If true, the target VMs will be powered on right after the failback.

quickRollback
boolean

If true, quick rollback is enabled (for VMware vSphere prior to version 7.0).

object (ReplicaFailbackModeSpec)

Failback mode.

Responses
201

One or more Failback sessions have been started to perform the failback. To check the progress, track the session state.

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

404

Not found. No object was found with the path parameter specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/failback/failbackToProduction/vSphere/snapshot
Request samples
application/json
{
  • "replicaPointIds": [
    ],
  • "type": "OriginalLocation",
  • "drSiteProxyId": [
    ],
  • "productionSiteProxyId": [
    ],
  • "powerOnTargetVM": true,
  • "quickRollback": true,
  • "failbackMode": {
    }
}
Response samples
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Switch Over to Production

The HTTP POST request to the /api/v1/failback/switchToProduction/vSphere/snapshot path allows you to manually switch over from snapshot replicas to production VMware vSphere VMs.

Available to: Veeam Backup Administrator, Veeam Restore Operator.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.3-rev0

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Request Body schema: application/json
required
replicaPointIds
Array of strings <uuid>

Array of replica restore points from which you want to switch over.

Responses
201

One or more SwitchReplicaToProduction sessions have been started to perform switchover. To check the progress, track the session state.

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

404

Not found. No object was found with the path parameter specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/failback/switchToProduction/vSphere/snapshot
Request samples
application/json
{
  • "replicaPointIds": [
    ]
}
Response samples
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Change Switchover Time

The HTTP POST request to the /api/v1/failback/changeSwitchoverTime/vSphere/snapshot path allows you to change the time when you want to switch over from snapshot replicas to production VMware vSphere VMs.

Available to: Veeam Backup Administrator, Veeam Restore Operator.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.3-rev0

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Request Body schema: application/json
required
replicaPointIds
Array of strings <uuid>

Array of replica restore points for which you want to change switchover time.

object (ReplicaFailbackModeSpec)

Failback mode.

Responses
200

Switchover time has been changed successfully.

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

404

Not found. No object was found with the path parameter specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/failback/changeSwitchoverTime/vSphere/snapshot
Request samples
application/json
{
  • "replicaPointIds": [
    ],
  • "failbackMode": {
    }
}
Response samples
application/json
{ }

Commit Failback

The HTTP POST request to the /api/v1/failback/commitFailback/vSphere/snapshot path allows you to commit failback from snapshot replicas to production VMware vSphere VMs.

Available to: Veeam Backup Administrator, Veeam Restore Operator.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.3-rev0

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Request Body schema: application/json
required
replicaPointIds
Array of strings <uuid>

Array of replica restore points for which you want to perform failback.

Responses
201

One or more CommitFailback sessions have been started to commit the failback. To check the progress, track the session state.

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

404

Not found. No object was found with the path parameter specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/failback/commitFailback/vSphere/snapshot
Request samples
application/json
{
  • "replicaPointIds": [
    ]
}
Response samples
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Undo Failback

The HTTP POST request to the /api/v1/failback/undoFailback/vSphere/snapshot path allows you to undo failback from snapshot replicas to production VMware vSphere VMs.

Available to: Veeam Backup Administrator, Veeam Restore Operator.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.3-rev0

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Request Body schema: application/json
required
replicaPointIds
Array of strings <uuid>

Array of replica restore points for which you want to undo failback.

Responses
201

One or more UndoFailback sessions have been started to undo the failback. To check the progress, track the session state.

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

404

Not found. No object was found with the path parameter specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/failback/undoFailback/vSphere/snapshot
Request samples
application/json
{
  • "replicaPointIds": [
    ]
}
Response samples
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}