Get All Groups in Plan

You can get a list of all groups included in a plan with the specified ID.

Request

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

Tip

VAO entity can be edited by another user while you are working with the VAO REST API. To define whether to include changes of the current editing session to the response, specify the includeEditingChanges parameter after the endpoint of the request URL: ?includeEditingChanges=true/false.

HTTP Request

GET https://<hostname>:<port>/api/v3/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 /Groups collection for the specified plan. The RecoveryGroupInfo schema is used for the collection representation.

Get All Groups in PlanExample

The following request returns a list of groups included in a plan with the ID cd47d232-44f6-4c1c-84e2-8033049a5cfa.

Request:

GET https://uwin2012r2.n.local:9898/api/v3/Plans/cd47d232-44f6-4c1c-84e2-8033049a5cfa/Groups

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "total": 3,

 "data": [

   {

     "$id": "1",

     "id": "5e506709-f83e-4d44-9447-170d58251578",

     "name": "Pre-plan steps",

     "order": -2147483648,

     "vmGroupId": "00000000-0000-0000-0000-000000000000",

     "serverId": "00000000-0000-0000-0000-000000000000",

     "isDefault": false,

     "isParallel": false,

     "type": "VirtualGroup",

     "virtualType": "PreFailover",

     "isProtected": false,

     "protectVBRJobId": null,

     "protectVBRJobName": null,

     "protectVBRJobServerId": null,

     "parallelProcessingVmsCount": 0,

     "vmCount": 0,

     "stepCount": 3,

     "vmsCriticality": "AllCritical",

     "executionType": "Replica",

     "restoreVmTags": false,

     "sourceMissing": false,

     "defaultCredentialId": null

   },

   {

     "$id": "2",

     "id": "b0ed96ba-be18-4d3a-a658-613c8550e966",

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

     "order": 0,

     "vmGroupId": "650316d2-fb9f-464b-8b90-d63b81732e15",

     "serverId": "759c7afa-9ed0-4a60-8452-16bcfb5998d5",

     "isDefault": false,

     "isParallel": true,

     "type": "VmGroup",

     "virtualType": "Normal",

     "isProtected": false,

     "protectVBRJobId": null,

     "protectVBRJobName": null,

     "protectVBRJobServerId": null,

     "parallelProcessingVmsCount": 10,

     "vmCount": 5,

     "stepCount": 0,

     "vmsCriticality": "AllNotCritical",

     "executionType": "Restore",

     "restoreVmTags": false,

     "sourceMissing": false,

     "defaultCredentialId": null

   },

   {

     "$id": "3",

     "id": "2547b552-ba22-4b2b-8beb-46c45922102d",

     "name": "Post-plan steps",

     "order": 2147483647,

     "vmGroupId": "00000000-0000-0000-0000-000000000000",

     "serverId": "00000000-0000-0000-0000-000000000000",

     "isDefault": false,

     "isParallel": false,

     "type": "VirtualGroup",

     "virtualType": "PostFailover",

     "isProtected": false,

     "protectVBRJobId": null,

     "protectVBRJobName": null,

     "protectVBRJobServerId": null,

     "parallelProcessingVmsCount": 0,

     "vmCount": 0,

     "stepCount": 2,

     "vmsCriticality": "AllCritical",

     "executionType": "Replica",

     "restoreVmTags": false,

     "sourceMissing": false,

     "defaultCredentialId": null

   }

 ]

}

}

I want to report a typo

There is a misspelling right here:

 

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