Veeam Backup & Replication 13
REST API Reference
Related documents

Failover

The Failover section defines paths and operations for managing failover.

Start Failover

The HTTP POST request to the /api/v1/failover/failoverNow/vSphere/snapshot path allows you to start failover of VMware vSphere VMs to their snapshot replicas.

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
required
Array of strings <uuid>

Array of replica restore points.

reason
string

Operation reason.

Responses
201

One or more Failover sessions have been started to perform the failover. 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/failover/failoverNow/vSphere/snapshot
Request samples
application/json
{
  • "replicaPointIds": [
    ]
}
Response samples
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Start Planned Failover

The HTTP POST request to the /api/v1/failover/plannedFailover/vSphere/snapshot path allows you to start planned failover of VMware vSphere VMs to their snapshot replicas.

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
required
Array of strings <uuid>

Array of replica restore points.

reason
string

Operation reason.

Responses
201

One or more PlannedFailover sessions have been started to perform the failover. 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/failover/plannedFailover/vSphere/snapshot
Request samples
application/json
{
  • "replicaPointIds": [
    ]
}
Response samples
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Start Permanent Failover

The HTTP POST request to the /api/v1/failover/permanentFailover/vSphere/snapshot path allows you to start permanent failover of VMware vSphere VMs to their snapshot replicas.

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
required
Array of strings <uuid>

Array of replica restore points.

reason
string

Operation reason.

Responses
201

One or more PermanentFailover sessions have been started to perform the failover. 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/failover/permanentFailover/vSphere/snapshot
Request samples
application/json
{
  • "replicaPointIds": [
    ]
}
Response samples
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Undo Failover

The HTTP POST request to the /api/v1/failover/undoFailover/vSphere/snapshot path allows you to undo failover for snapshot replicas of 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
required
Array of strings <uuid>

Array of replica restore points.

reason
string

Operation reason.

Responses
201

One or more UndoFailover sessions have been started to undo the failover. 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/failover/undoFailover/vSphere/snapshot
Request samples
application/json
{
  • "replicaPointIds": [
    ]
}
Response samples
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}