REST endpoints: Automation

These endpoints mirror the CLI commands described in Automation. Each endpoint runs the CLI command named under its heading, so the behavior, defaults, and restrictions are the same; this page lists how to call it over REST.

Conventions that apply to every endpoint (request format, the async and outputType parameters, and the response envelope) are in Requests and responses. In the tables below, Required is Yes when the parameter must always be supplied, No when it is optional, and Depends when it is required only in some combinations (for example, either an application and volume, or a consistency group ID); the CLI chapter for the same command explains the combinations.

POST /automation/create

Create a new automation workflow.

CLI command: automation create

Body fields (JSON)

Name	Type	Required	Description
AutomationWorkflowName	string	Yes	The name of the automation workflow.
CommandPaths	array of string	Yes	The commands to run, in order (Get commands are not allowed).
CommandParameters	array of string	No	The parameters for each command, matched by position.

DELETE /automation/delete

Delete an automation workflow.

CLI command: automation delete

Query parameters

Name	Type	Required	Description
automationWorkflowName	string	Yes	The automation workflow to delete.

PUT /automation/edit

Edit an existing automation workflow.

CLI command: automation edit

Query parameters

Name	Type	Required	Description
automationWorkflowName	string	Yes	The automation workflow to edit.

Body fields (JSON)

Name	Type	Required	Description
AutomationWorkflowName	string	Yes	The automation workflow to edit.
CommandPaths	array of string	Yes	The commands to run, in order (Get commands are not allowed).
CommandParameters	array of string	No	The parameters for each command, matched by position.

PUT /automation/execute

Execute an automation workflow.

CLI command: automation execute

Query parameters

Name	Type	Required	Description
automationWorkflowName	string	Yes	The automation workflow to execute.

Body fields (JSON)

Name	Type	Required	Description
Variables	array of string	No	The @token@ placeholders to substitute in the workflow's commands.
Values	array of string	No	The value for each variable, matched by position.

GET /automation/list

List all configured automation workflows.

CLI command: automation list

Query parameters

Name	Type	Required	Description
automationWorkflowName	string	No	Filter by workflow name.

Response: a list of AutomationWorkflowElement objects in Result, each with: AutomationWorkflowName (string), CommandPaths (array of string), CommandParameters (array of string).

---

See also: Requests and responses - Authentication - Examples