Perform Action

Perform Action


Performing a POST /api/actions/{id} will attempt to trigger the
action with specified id. It is considered a best practice to use the actionExecution field from the
POST /api/action/{id}/query that has been previously executed to populate
the body of the request. Please note that additional values may be required in order to make
the populateAction response body valid.

Request
URI
POST
https://{api_host}/suite-api/api/actions/{id}
COPY
Path Parameters
string
id
Required

The id for the action to be executed (can be retrieved via: GET /api/actiondefinitions)

Request Body

Describe instance data about performing an action.

action-execution of type(s) application/json
Required

Show optional properties

{
    "parameterGroup": [
        {
            "resourceId": "string"
        }
    ]
}
"{\n  \"contextId\" : \"PowerOffVM\",\n  \"contextResourceId\" : [ \"7e780215-da07-4da1-9167-cd6892dcfdd8\" ],\n  \"parameterGroup\" : [ {\n    \"resourceId\" : \"7e780215-da07-4da1-9167-cd6892dcfdd8\"\n  } ]\n}"
string
contextId
Optional

An optional value naming the action step that will be executed

array of string
contextResourceId
Optional

The UUID list of resources that the action will be performed against

array of object
parameterGroup
Required

The parameters that are used as inputs for the action being performed

Authentication
This operation uses the following authentication methods.
Responses
200

List of Task Ids for the action run.

Returns str-values of type(s) application/json 
"{\n  \"values\" : [ \"6efd4c8d-c38a-4dc6-b8a8-980a06f55900\" ]\n}"
array of string
values
Optional

values


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"parameterGroup":["object"]}' https://{api_host}/suite-api/api/actions/{id}
On This Page
Actions Operations
POST
Perform Action
POST
Populate Action
GET
Get Action Status
GET
Get All Actions