Veeam Availability Orchestrator 3.0
REST API Reference
Related documents

Get Details for Groups in Plan

You can get runtime details for every group included in a plan with the specified ID.

Request

To retrieve a representation of a collection for all groups in a specific plan, send the HTTP GET request to the /RuntimeDetails/Plans/{planId}/Groups endpoint.

HTTP Request

GET https://<hostname>:<port>/api/v3/RuntimeDetails/Plans/{planId}/Groups

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 /RuntimeDetails collection for all groups included in the specified plan. The GroupRuntimeDetails schema is used for the collection representation.

Get Details for Groups in PlanExample

The following request returns runtime details for all groups included in a plan with the ID 62685fe6-222a-493d-a99b-feea900921a2.

Request:

GET https://uwin2012r2.n.local:9898/api/v3/RuntimeDetails/Plans/62685fe6-222a-493d-a99b-feea900921a2/Groups

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "total": 3,

 "data": [

   {

     "groupType": "VirtualGroup",

     "successCount": 1,

     "warningCount": 1,

     "errorCount": 0,

     "totalCount": 2,

     "isProtected": false,

     "isParallel": false,

     "parallelProcessingVmsCount": 0,

     "vmsCriticality": "AllCritical",

     "executionState": "Completed",

     "executionResult": {

       "startTime": "2020-07-09T07:23:32.3329724Z",

       "finishTime": "2020-07-09T07:23:32.3642281Z",

       "result": "Warning",

       "details": []

     },

     "id": "a949ff2c-3ca7-44f8-a7cc-4bf5428d8cc7",

     "name": "Pre-plan steps",

     "progress": 100

   },

   {

     "groupType": "VmGroup",

     "successCount": 0,

     "warningCount": 1,

     "errorCount": 0,

     "totalCount": 1,

     "isProtected": false,

     "isParallel": true,

     "parallelProcessingVmsCount": 10,

     "vmsCriticality": "AllNotCritical",

     "executionState": "Completed",

     "executionResult": {

       "startTime": "2020-07-09T07:23:32.3642281Z",

       "finishTime": "2020-07-09T07:23:33.0048268Z",

       "result": "Warning",

       "details": []

     },

     "id": "fdd0af10-b0b4-4458-acf7-25c006f44517",

     "name": "win12-VMs - win12-10-4",

     "progress": 100

   },

   {

     "groupType": "VirtualGroup",

     "successCount": 0,

     "warningCount": 0,

     "errorCount": 0,

     "totalCount": 0,

     "isProtected": false,

     "isParallel": false,

     "parallelProcessingVmsCount": 0,

     "vmsCriticality": "AllCritical",

     "executionState": "Completed",

     "executionResult": {

       "startTime": "2020-07-09T07:23:33.0048268Z",

       "finishTime": "2020-07-09T07:23:33.0048268Z",

       "result": "Success",

       "details": []

     },

     "id": "d1d2758d-049b-4ac3-8205-9362e6d25231",

     "name": "Post-plan steps",

     "progress": 100

   }

 ]

}

]

This Document Help Center
User GuideGroup Management GuideREST API ReferenceVeeam Backup & Replication DocumentationVeeam ONE Documentation
I want to report a typo

There is a misspelling right here:

 

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