Get Parameters Configured for Step in Plan

You can get a list of all parameters configured for a step with the specified ID included in a specific plan.

Request

To retrieve a representation of a collection of parameters configured for a specific step, send the HTTP GET request to the /Steps/{stepId}/Parameters 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}/Steps/{stepId}/Parameters

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 /Parameters collection for the specified step. The StepParameterInfo schema is used for the collection representation.

Get Parameters Configured for Step in PlanExample

The following request returns a list of parameters configured for a step with ID f47b0a88-81ea-40e9-b3db-c45c5841564c 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/Steps/f47b0a88-81ea-40e9-b3db-c45c5841564c

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "total": 6,

 "data": [

   {

     "$id": "1",

     "id": "2766ac19-21d9-4c5b-8af5-ae9e16e1504a",

     "order": 0,

     "isEditable": false,

     "isSystem": true,

     "isArgument": false,

     "isCommon": true,

     "displayName": "Description",

     "name": "Description",

     "description": "Step description",

     "value": "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.",

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

     "type": "TextArea",

     "planId": "cd47d232-44f6-4c1c-84e2-8033049a5cfa"

   },

   {

     "$id": "2",

     "id": "fdacee30-2d66-4a26-85f2-adf40aedd115",

     "order": 1,

     "isEditable": true,

     "isSystem": true,

     "isArgument": false,

     "isCommon": true,

     "displayName": "Failback & Undo Failover Action",

     "name": "UndoAction",

     "description": "Choose Execute or Skip to define whether this step will be executed during Failback and Undo Failover operations. Note that if you set the parameter value to Execute, the source VM will be checked (as opposite to the replica VM check performed during Failover).",

     "value": "1",

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

     "type": "StepAction",

     "planId": "cd47d232-44f6-4c1c-84e2-8033049a5cfa"

   },

   {

     "$id": "3",

     "id": "4ad83521-497f-4a89-9dec-5e14001d9f15",

     "order": 2,

     "isEditable": true,

     "isSystem": true,

     "isArgument": false,

     "isCommon": true,

     "displayName": "Test Action",

     "name": "TestAction",

     "description": "Choose Execute or Skip to define whether this step is executed during plan testing in DataLab",

     "value": "0",

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

     "type": "StepTestAction",

     "planId": "cd47d232-44f6-4c1c-84e2-8033049a5cfa"

   },

   {

     "$id": "4",

     "id": "2ff3469c-9265-405f-b687-515e0d7d8ca6",

     "order": 3,

     "isEditable": true,

     "isSystem": true,

     "isArgument": false,

     "isCommon": true,

     "displayName": "Critical Step",

     "name": "CriticalStep",

     "description": "Choose Yes or No to define whether this step is critical to the VM recovery. If critical step for a critical VM, then failure will halt the plan.",

     "value": "False",

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

     "type": "Boolean",

     "planId": "cd47d232-44f6-4c1c-84e2-8033049a5cfa"

   },

   {

     "$id": "5",

     "id": "eb8be621-e788-4a23-86b2-71de3ed8ec03",

     "order": 4,

     "isEditable": true,

     "isSystem": true,

     "isArgument": false,

     "isCommon": true,

     "displayName": "Timeout",

     "name": "Timeout",

     "description": "Timeout (in seconds) for the step",

     "value": "600",

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

     "type": "Timeout",

     "planId": "cd47d232-44f6-4c1c-84e2-8033049a5cfa"

   },

   {

     "$id": "6",

     "id": "26bbb146-65a2-4cef-82b4-f52e70f066bf",

     "order": 5,

     "isEditable": true,

     "isSystem": true,

     "isArgument": false,

     "isCommon": true,

     "displayName": "Retries",

     "name": "Retries",

     "description": "Number of retries to perform in case the step fails on the first try.",

     "value": "0",

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

     "type": "Retries",

     "planId": "cd47d232-44f6-4c1c-84e2-8033049a5cfa"

   }

 ]

}

I want to report a typo

There is a misspelling right here:

 

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