Veeam Backup & Replication Failover Plans

This resource collection represents failover plans configured in monitored Veeam Backup & Replication infrastructure.

Get All Failover Plans

Returns a collection resource representation of all failover plans.

SecurityBearer
Request
query Parameters
Offset
integer <int32>
Default: 0
Limit
integer <int32>
Default: 100
Filter
string
Sort
string
Select
string
Responses
200

Success

403

Forbidden

get/api/v2.3/vbr/failoverPlans
Request samples
Response samples
application/json
{
  • "items": [
    ],
  • "totalCount": 0
}

Get Failover Plan

Returns a resource representation of a failover plan with the specified UID.

SecurityBearer
Request
path Parameters
failoverPlanUid
required
string <uuid>
Responses
200

Success

403

Forbidden

get/api/v2.3/vbr/failoverPlans/{failoverPlanUid}
Request samples
Response samples
application/json
{
  • "failoverPlanUid": "b9431b24-01ce-4c44-9243-5ed9587d1f3f",
  • "backupServerId": 0,
  • "status": "Unknown",
  • "name": "string",
  • "description": "string",
  • "lastRun": "2019-08-24T14:15:22Z"
}

Document updated 9/08/2025

Page content applies to build 13.0.0.5630