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

curl

Response samples

application/json

{"items": [{"failoverPlanUid": "91994ea8-c93d-4427-9dab-21188400485e",
"backupServerId": 7200,
"status": "Ready",
"name": "Failover plan 1",
"description": "Created by VBR\\administrator at 12/20/2022 00:10.",
"lastRun": null
},
{"failoverPlanUid": "dad2ad98-e200-46b5-80da-234744bde13b",
"backupServerId": 7200,
"status": "Ready",
"name": "MK failover plan HV",
"description": "Created by VBR\\administrator at 12/29/2022 9:14 AM.",
"lastRun": null
},
{"failoverPlanUid": "d24dfc52-fb86-451c-9102-28a25c83fe10",
"backupServerId": 7200,
"status": "Ready",
"name": "Failover plan 3 CDP",
"description": "Created by VBR\\administrator at 11/15/2022 21:30.",
"lastRun": null
},
{"failoverPlanUid": "42d59f87-83d8-4552-b93b-3911e5196d72",
"backupServerId": 7200,
"status": "Ready",
"name": "MK failover plan VW",
"description": "Created by VBR\\administrator at 12/29/2022 9:15 AM.",
"lastRun": null
}
],
"totalCount": 4
}

Get Failover Plan

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

SecurityBearer

Request

path Parameters

failoverPlanUid

required

string <uuid>

Failover plan UID.