STstackstorm

POST /api/v1/executions

Create a new execution.

Request

  • The document declares no server URL.
  • Auth
    • API key in header X-Auth-Token
    • or API key in header St2-Api-Key
    • or API key in query parameter x-auth-token
    • or API key in query parameter st2-api-key
    • or API key in header auth-token

Query parameters

show_secretsboolean

Show secrets in plain text

Headers

st2-contextstring

Additional execution context

Request body

idstring

The unique identifier for the action execution.

status'requested' | 'scheduled' | 'delayed' | 'running' | 'succeeded' | 'failed' | 'timeout' | 'abandoned' | 'canceling' | 'canceled' | 'pending' | 'pausing' | 'paused' | 'resuming'

The current status of the action execution.

start_timestampstring

The start time when the action is executed.

end_timestampstring

The timestamp when the action has finished.

actionstring required

Reference to the action to be executed.

action_is_workflowboolean

Flag indicating workflow action.

parametersobject

Input parameters for the action.

resultobject
contextobject
callbackobject
runner_infoobject
delayinteger

How long (in milliseconds) to delay the execution before scheduling.

userstring nullable

User context under which action should run (admins only)

Response

Execution being created

idstring required
triggerTrigger
trigger_typeTriggerType
trigger_instanceTriggerInstance
ruleRule
actionobject
runnerobject
liveaction_idstring
task_executionstring
workflow_executionstring
status'requested' | 'scheduled' | 'delayed' | 'running' | 'succeeded' | 'failed' | 'timeout' | 'abandoned' | 'canceling' | 'canceled' | 'pending' | 'pausing' | 'paused' | 'resuming'

The current status of the action execution.

start_timestampstring

The start time when the action is executed.

end_timestampstring

The timestamp when the action has finished.

elapsed_secondsnumber

Time duration in seconds taken for completion of this execution.

web_urlstring

History URL for this execution if you want to view in UI.

parametersobject

Input parameters for the action.

contextobject
resultobject
result_sizeinteger
parentstring
childrenstring[]
delayinteger

How long (in milliseconds) to delay the execution before scheduling.

Changes

No recorded changes to this operation across all 73 revisions of this API.