Get All Objects of Failover Plan
You can get a collection resource representation of all VMs included in a failover plan 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 VMs included in a failover plan, send the GET HTTP request to the URL of the /infrastructure/backupServers/failoverplans/{planUid}/objects collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/failoverplans/{planUid}/objects |
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 |
|---|---|---|---|---|---|
planUid | Path | String (uuid) | Yes | — | Failover plan 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 BackupFailoverPlanObject schema.
Example 
The following request returns a representation of all objects of a failover plan with UID a69ad214-e225-49bf-8fb8-f16340729b7b.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/jobs/failoverPlans/a69ad214-e225-49bf-8fb8-f16340729b7b/objects
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "423b64a5-21b6-6599-839c-3ab014524313", "planUid": "a69ad214-e225-49bf-8fb8-f16340729b7b", "name": "FP1", "hostName": "", "folderName": "", "path": "\\\\vbr7.prod1.local\\C$\\setup", "backupServerUid": "2ce089cd-c9cb-4ea4-bdad-a635ea96f44b" }, { "instanceUid": "a4e3e026-a845-4d88-83a1-427f12784bc6", "planUid": "a69ad214-e225-49bf-8fb8-f16340729b7b", "name": "FP3", "hostName": "srv21", "folderName": "", "path": "C:/Tape", "backupServerUid": "2ce089cd-c9cb-4ea4-bdad-a635ea96f44b" } ] } |
