This is an archive version of the document. To get the most up-to-date information, see the current version.Get All Failover Plans Configured on Backup Server
You can get a collection resource representation of all failover plans configured on a Veeam Backup & Replication server with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To get a representation of all failover plans configured on a specific Veeam Backup & Replication server, send the GET HTTP request to the URL of the /infrastructure/backupServers/{backupServerUid}/failoverplans collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/{backupServerUid}/failoverplans |
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. |
Accept | Optional | application/json | 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 parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
backupServerUid | Path | String (uuid) | Yes | — | Backup server UID |
limit | Query | Integer (int32) | No | 100 | Specifies the first N resources that must be returned in the output |
offset | Query | Integer (int32) | No | 0 | Excludes the first N resources from the query output |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a collection resource representation based on the BackupFailoverPlan schema.
Example 
The following request returns a representation of all failover plans configured on a Veeam Backup & Replication server with UID 4aa2a01c-d14f-4d6e-b0fa-2e1e9a2891e3.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/4aa2a01c-d14f-4d6e-b0fa-2e1e9a2891e3/failoverPlans
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "e46e46ea-192a-4018-ac14-cd1a3a3313de", "originalUid": "c6cc1ad9-9ab9-4d30-9cc7-df44538c784f", "backupServerUid": "4aa2a01c-d14f-4d6e-b0fa-2e1e9a2891e3", "name": "CloudFailoverPlan", "type": "tenant", "status": "ready", "tenantUid": "4556b33c-83f0-46a3-9007-470d15374c3e", "objectsCount": 1, "preFailoverCommand": "", "postFailoverCommand": "" }, { "instanceUid": "b0164e89-9076-344a-fc5d-916041116d70", "originalUid": "cb3efde8-f21a-4a4f-ae0e-d1361d8f5d75", "backupServerUid": "4aa2a01c-d14f-4d6e-b0fa-2e1e9a2891e3", "name": "Local Failover Plan", "type": "local", "status": "ready", "tenantUid": "00000000-0000-0000-0000-000000000000", "objectsCount": 1, "preFailoverCommand": "", "postFailoverCommand": "" } ] } |