Get Steps Added for VM in Plan

You can get a list of all steps added for a VM with the specified ID included in a specific plan.

Request

To retrieve a representation of a collection of steps added for a specific VM, send the HTTP GET request to the /Vms/{vmId}/Steps 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}/Vms/{vmId}/Steps

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 /Steps collection for the specified VM. The StepInfoModel schema is used for the collection representation.

Get Steps Added for VM in PlanExample

The following request returns a list of steps added for a VM with ID 6dda5b80-d3c9-43fd-9f1d-0b6537ce40cf 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/Vms/6dda5b80-d3c9-43fd-9f1d-0b6537ce40cf/Steps

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "total": 4,

 "data": [

   {

     "$id": "1",

     "name": "Restore VM",

     "type": "Action",

     "state": "Ready",

     "id": "fb2abecb-883e-4f31-abe5-0c57abda0b17",

     "order": 1,

     "description": "This Step is a default step for every VM added to a Restore Plan. The Step restores the VM from the associated backup file to the location specified as the Recovery Location.",

     "requiredForSuccess": true,

     "stepDefinitionUid": "8a001db8-284a-405c-830b-b3d6b27f4fb7",

     "enabledForCurrentUser": true

   },

   {

     "$id": "2",

     "name": "Check VM Heartbeat",

     "type": "Action",

     "state": "Ready",

     "id": "dace1200-d683-4867-a1bb-829f9781ca22",

     "order": 2,

     "description": "This Step checks heartbeat of the VM using VMware Tools. If VMware Tools are not installed, remove this Step.",

     "requiredForSuccess": true,

     "stepDefinitionUid": "37c36a1d-8434-4c87-b5f8-ffa8d7ee7814",

     "enabledForCurrentUser": true

   },

   {

     "$id": "3",

     "name": "Ping VM Network",

     "type": "Action",

     "state": "Ready",

     "id": "f47b0a88-81ea-40e9-b3db-c45c5841564c",

     "order": 3,

     "description": "This Step pings all IP addresses of the replica VM until they are stable or the timeout is exceeded. Communication ports on any firewalls located between the Veeam Backup & Replication server and the VM guest OS must be open for ICMP ping – otherwise, the Step will fail to complete successfully.",

     "requiredForSuccess": false,

     "stepDefinitionUid": "c9c20a77-c056-4314-aa33-55aeca685302",

     "enabledForCurrentUser": true

   },

   {

     "$id": "4",

     "name": "Verify Web Server Port",

     "type": "Action",

     "state": "Ready",

     "id": "b4157056-df39-4bb4-9aaa-c9956e4910ce",

     "order": 4,

     "description": "This Step verifies the port used to connect to the VM with the Web Server role.",

     "requiredForSuccess": true,

     "stepDefinitionUid": "1034bfc7-d8b2-4c89-b755-fb95977ae198",

     "enabledForCurrentUser": true

   }

 ]

}

I want to report a typo

There is a misspelling right here:

 

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