Get Collection of Plans

You can get a list of all created VAO plans.

Request

To retrieve a representation of a collection of plans, send the HTTP GET request to the /Plans endpoint.

Tip

You can get a list of ENABLED plans. To do that, specify the true value of the onlyEnabled parameter after the endpoint of the request URL: ?onlyEnabled=true.

For more information on states that a plan can acquire, see the Veeam Availability Orchestrator User Guide, sections Running and Scheduling Replica Plans, Running and Scheduling Restore Plans, Running and Scheduling Storage Plans.

HTTP Request

GET https://<hostname>:<port>/api/v3/Plans

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/xml
  • text/json
  • 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.

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns 200 response code.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Value

Description

Content-Length

integer

Identifies the length of the response body message, in bytes.

Content-Type

  • application/xml
  • text/json
  • application/json

Identifies the media type of the response body message.

Response Body

In the response body, VAO returns a representation of the /Plans collection. The RecoveryPlanInfo schema is used for the collection representation.

Get Collection of PlansExample

The following request returns a full list of VAO plans.

Request:

GET https://uwin2012r2.n.local:9898/api/v3/Plans

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "total": 3,

 "data": [

   {

     "$id": "1",

     "id": "50dca987-176a-47ac-89ff-c504a36c4bc4",

     "planType": "Replica",

     "recoveryLocationId": null,

     "serverId": "12e047b9-256f-4c56-9428-01fb3e75cb51",

     "siteScopeId": "76579fc8-08fa-4759-a106-ca7cff5afe50",

     "siteScopeName": "Admin Scope",

     "name": "Failover-Win10",

     "state": "Unpublished",

     "stateName": "Not Verified",

     "stateOrder": "410. Not Verified",

     "resultName": "Failed check, no errors, 1 warning",

     "lastStableState": "Unpublished",

     "lastStableStateName": "Not Verified",

     "previousExecutionState": "DryRun",

     "reportTemplateId": "2347caea-801a-4e90-9397-61be1074ad1d",

     "description": "Replica plan",

     "reportDocumentFormat": "Pdf",

     "serverName": "uwin2012r2.n.local",

     "siteName": "uwin2012r2",

     "scheduleInfo": null,

     "nearestFailoverScheduleTime": null,

     "scheduledTestsInfo": [],

     "nearestTestScheduleTime": null,

     "haltedReason": "Undefined",

     "isEditingByCurrentUser": false,

     "currentEditingUser": "",

     "progress": 100,

     "lastTestResult": "Undefined",

     "lastTestTime": null,

     "lastCheckResult": "Warning",

     "lastCheckTime": "2020-07-20T01:17:53.3029891Z",

     "lastTestResultName": "Never",

     "lastTestResultOrderNumber": 5,

     "lastCheckResultName": "Warning",

     "lastCheckResultOrderNumber": 3,

     "virtualLabId": null,

     "contactName": "Wendy May",

     "contactEmail": "wendy.may@veeam.com",

     "contactTel": "3232556666",

     "isRunningState": false,

     "isStableState": true,

     "currentRunResult": "Undefined",

     "currentTestResult": "Undefined",

     "currentCheckResult": "Warning",

     "definitionReportStartTime": "2020-07-20T04:00:00Z",

     "readinessCheckStartTime": "2020-07-20T05:00:00Z",

     "targetRecoveryTimeObjective": 60,

     "currentRecoveryTimeObjective": 1,

     "targetRecoveryPointObjective": 2048,

     "currentRecoveryPointObjective": 60942,

     "roles": [

       "DRSiteAdmin"

     ]

   },

   {

     "$id": "2",

     "id": "48e4d48d-a44f-4e04-b4ee-fbe56fc06e5c",

     "planType": "Restore",

     "recoveryLocationId": "5ecf1a64-eb52-4c67-abf1-c868df69d686",

     "serverId": "12e047b9-256f-4c56-9428-01fb3e75cb51",

     "siteScopeId": "76579fc8-08fa-4759-a106-ca7cff5afe50",

     "siteScopeName": "Admin Scope",

     "name": "Winserv04",

     "state": "Restored",

     "stateName": "Restored",

     "stateOrder": "300. Restored",

     "resultName": "Complete, 1 error, 4 warnings",

     "lastStableState": "Restored",

     "lastStableStateName": "Restored",

     "previousExecutionState": "Restoring",

     "reportTemplateId": "2347caea-801a-4e90-9397-61be1074ad1d",

     "description": "Restore plan",

     "reportDocumentFormat": "Pdf",

     "serverName": "uwin2012r2.n.local",

     "siteName": "uwin2012r2",

     "scheduleInfo": null,

     "nearestFailoverScheduleTime": null,

     "scheduledTestsInfo": [],

     "nearestTestScheduleTime": null,

     "haltedReason": "Undefined",

     "isEditingByCurrentUser": false,

     "currentEditingUser": "",

     "progress": 100,

     "lastTestResult": "Undefined",

     "lastTestTime": null,

     "lastCheckResult": "Error",

     "lastCheckTime": "2020-07-20T11:11:10.9738681Z",

     "lastTestResultName": "Never",

     "lastTestResultOrderNumber": 5,

     "lastCheckResultName": "Failed",

     "lastCheckResultOrderNumber": 2,

     "virtualLabId": null,

     "contactName": "Wendy May",

     "contactEmail": "wendy.may@veeam.com",

     "contactTel": "3232556666",

     "isRunningState": false,

     "isStableState": true,

     "currentRunResult": "Warning",

     "currentTestResult": "Undefined",

     "currentCheckResult": "Error",

     "definitionReportStartTime": "2020-07-20T04:00:00Z",

     "readinessCheckStartTime": "2020-07-20T05:00:00Z",

     "targetRecoveryTimeObjective": 60,

     "currentRecoveryTimeObjective": 0,

     "targetRecoveryPointObjective": 1440,

     "currentRecoveryPointObjective": 22,

     "roles": [

       "DRSiteAdmin"

     ]

   },  

   {

     "$id": "3",

     "id": "da3e43d4-01f5-48f4-a9be-3e015e6b1408",

     "planType": "Storage",

     "recoveryLocationId": null,

     "serverId": "12e047b9-256f-4c56-9428-01fb3e75cb51",

     "siteScopeId": "76579fc8-08fa-4759-a106-ca7cff5afe50",

     "siteScopeName": "Admin Scope",

     "name": "StorNFS",

     "state": "Unpublished",

     "stateName": "Verified",

     "stateOrder": "410. Verified",

     "resultName": "Passed check",

     "lastStableState": "Unpublished",

     "lastStableStateName": "Verified",

     "previousExecutionState": "DryRun",

     "reportTemplateId": "2347caea-801a-4e90-9397-61be1074ad1d",

     "description": "Storage plan",

     "reportDocumentFormat": "Pdf",

     "serverName": "uwin2012r2.n.local",

     "siteName": "uwin2012r2",

     "scheduleInfo": null,

     "nearestFailoverScheduleTime": null,

     "scheduledTestsInfo": [],

     "nearestTestScheduleTime": null,

     "haltedReason": "Undefined",

     "isEditingByCurrentUser": false,

     "currentEditingUser": "",

     "progress": 100,

     "lastTestResult": "Undefined",

     "lastTestTime": null,

     "lastCheckResult": "Success",

     "lastCheckTime": "2020-07-20T00:55:25.3162427Z",

     "lastTestResultName": "Never",

     "lastTestResultOrderNumber": 5,

     "lastCheckResultName": "Passed",

     "lastCheckResultOrderNumber": 4,

     "virtualLabId": null,

     "contactName": "Wendy May",

     "contactEmail": "wendy.may@veeam.com",

     "contactTel": "3232556666",

     "isRunningState": false,

     "isStableState": true,

     "currentRunResult": "Undefined",

     "currentTestResult": "Undefined",

     "currentCheckResult": "Success",

     "definitionReportStartTime": "2020-07-20T04:00:00Z",

     "readinessCheckStartTime": "2020-07-20T05:00:00Z",

     "targetRecoveryTimeObjective": 1,

     "currentRecoveryTimeObjective": 0,

     "targetRecoveryPointObjective": 2048,

     "currentRecoveryPointObjective": 6,

     "roles": [

       "DRSiteAdmin"

     ]

   }

 ]

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.