GET /api/v1/executions

Returns a list of all executions.

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

exclude_attributesstring[]

List of attributes to exclude

include_attributesstring[]

List of attributes to include

limitinteger

Number of executions to get

offsetinteger

Number of executions to offset

sortstring

Comma-separated list of fields to sort by

sort_ascstring

Sort in ascending order

sort_descstring

Sort in descending order

idstring[]

Execution id filter

statusstring

Execution status filter

parentstring

Parent execution filter

trigger_typestring

Trigger type filter

triggerstring

Trigger filter

trigger_instancestring

Trigger instance filter

rulestring

Rule filter

actionstring

Action ref filter

runnerstring

Runner filter

userstring

User filter

liveactionstring

Liveaction id filter

timestampstring

Start timestamp filter

timestamp_ltstring

Start timestamp less than filter

timestamp_gtstring

Start timestamp greater than filter

show_secretsboolean

Show secrets in plain text

Response

List of executions

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.