v1executions

Returns a list of all executions.

Query parameters
exclude_attributes
array[string]
List of attributes to exclude
include_attributes
array[string]
List of attributes to include
limit
integer
Number of executions to get
offset
integer
Number of executions to offset
sort
string
Comma-separated list of fields to sort by
sort_asc
string
Sort in ascending order
sort_desc
string
Sort in descending order
id
array[string]
Execution id filter
status
string
Execution status filter
parent
string
Parent execution filter
trigger_type
string
Trigger type filter
trigger
string
Trigger filter
trigger_instance
string
Trigger instance filter
rule
string
Rule filter
action
string
Action ref filter
runner
string
Runner filter
user
string
User filter
liveaction
string
Liveaction id filter
timestamp
string
Start timestamp filter
timestamp_lt
string
Start timestamp less than filter
timestamp_gt
string
Start timestamp greater than filter
show_secrets
boolean
Show secrets in plain text
Responses

List of executions

array[object]
id
string
required
trigger
object
trigger_type
object
trigger_instance
object
rule
object
action
object
id
string
The unique identifier for the action.
ref
string
System computed user friendly reference for the action. Provided value will be overridden by computed value.
uid
string
name
string
The name of the action.
required
description
string
The description of the action.
enabled
boolean
Enable or disable the action from invocation.
runner_type
string
The type of runner that executes the action.
required
entry_point
string
The entry point for the action.
pack
string
The content pack this action belongs to.
parameters
object
Input parameters for the action.
tags
array[object]
User associated metadata assigned to this object.
notify
object
Notification settings for action.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
runner
object
liveaction
object
An execution of an action.
id
string
The unique identifier for the action execution.
status
string
The current status of the action execution.
start_timestamp
string
The start time when the action is executed.
end_timestamp
string
The timestamp when the action has finished.
action
string
Reference to the action to be executed.
required
action_is_workflow
boolean
Flag indicating workflow action.
parameters
object
Input parameters for the action.
result
object
context
object
callback
object
runner_info
object
notify
object
Notification settings for liveaction.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
task_execution
string
workflow_execution
string
status
string
The current status of the action execution.
start_timestamp
string
The start time when the action is executed.
end_timestamp
string
The timestamp when the action has finished.
elapsed_seconds
number
Time duration in seconds taken for completion of this execution.
web_url
string
History URL for this execution if you want to view in UI.
parameters
object
Input parameters for the action.
context
object
result
object
parent
string
children
array[string]
log
array[object]
Contains information about execution state transitions.
timestamp
string
status
string

Create a new execution.

Query parameters
show_secrets
boolean
Show secrets in plain text
Header parameters
st2-context
string
Additional execution context
Request body

Execution request

object
id
string
The unique identifier for the action execution.
status
string
The current status of the action execution.
start_timestamp
string
The start time when the action is executed.
end_timestamp
string
The timestamp when the action has finished.
action
string
Reference to the action to be executed.
required
action_is_workflow
boolean
Flag indicating workflow action.
parameters
object
Input parameters for the action.
result
object
context
object
callback
object
runner_info
object
notify
object
Notification settings for liveaction.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
user
string
User context under which action should run (admins only)
Responses

Execution being created

object
id
string
required
trigger
object
trigger_type
object
trigger_instance
object
rule
object
action
object
id
string
The unique identifier for the action.
ref
string
System computed user friendly reference for the action. Provided value will be overridden by computed value.
uid
string
name
string
The name of the action.
required
description
string
The description of the action.
enabled
boolean
Enable or disable the action from invocation.
runner_type
string
The type of runner that executes the action.
required
entry_point
string
The entry point for the action.
pack
string
The content pack this action belongs to.
parameters
object
Input parameters for the action.
tags
array[object]
User associated metadata assigned to this object.
notify
object
Notification settings for action.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
runner
object
liveaction
object
An execution of an action.
id
string
The unique identifier for the action execution.
status
string
The current status of the action execution.
start_timestamp
string
The start time when the action is executed.
end_timestamp
string
The timestamp when the action has finished.
action
string
Reference to the action to be executed.
required
action_is_workflow
boolean
Flag indicating workflow action.
parameters
object
Input parameters for the action.
result
object
context
object
callback
object
runner_info
object
notify
object
Notification settings for liveaction.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
task_execution
string
workflow_execution
string
status
string
The current status of the action execution.
start_timestamp
string
The start time when the action is executed.
end_timestamp
string
The timestamp when the action has finished.
elapsed_seconds
number
Time duration in seconds taken for completion of this execution.
web_url
string
History URL for this execution if you want to view in UI.
parameters
object
Input parameters for the action.
context
object
result
object
parent
string
children
array[string]
log
array[object]
Contains information about execution state transitions.
timestamp
string
status
string

Get a list of distinct values for the execution filters.

Query parameters
types
array[string]
List of types of filters to return
Responses

A number of distinct values for the requested filters

object

Get one execution.

Path parameters
id
string
Entity id
required
Query parameters
show_secrets
boolean
Show secrets in plain text
Responses

Execution requested

object
id
string
required
trigger
object
trigger_type
object
trigger_instance
object
rule
object
action
object
id
string
The unique identifier for the action.
ref
string
System computed user friendly reference for the action. Provided value will be overridden by computed value.
uid
string
name
string
The name of the action.
required
description
string
The description of the action.
enabled
boolean
Enable or disable the action from invocation.
runner_type
string
The type of runner that executes the action.
required
entry_point
string
The entry point for the action.
pack
string
The content pack this action belongs to.
parameters
object
Input parameters for the action.
tags
array[object]
User associated metadata assigned to this object.
notify
object
Notification settings for action.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
runner
object
liveaction
object
An execution of an action.
id
string
The unique identifier for the action execution.
status
string
The current status of the action execution.
start_timestamp
string
The start time when the action is executed.
end_timestamp
string
The timestamp when the action has finished.
action
string
Reference to the action to be executed.
required
action_is_workflow
boolean
Flag indicating workflow action.
parameters
object
Input parameters for the action.
result
object
context
object
callback
object
runner_info
object
notify
object
Notification settings for liveaction.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
task_execution
string
workflow_execution
string
status
string
The current status of the action execution.
start_timestamp
string
The start time when the action is executed.
end_timestamp
string
The timestamp when the action has finished.
elapsed_seconds
number
Time duration in seconds taken for completion of this execution.
web_url
string
History URL for this execution if you want to view in UI.
parameters
object
Input parameters for the action.
context
object
result
object
parent
string
children
array[string]
log
array[object]
Contains information about execution state transitions.
timestamp
string
status
string

Update status and result for an execution.

Path parameters
id
string
Entity id
required
Query parameters
show_secrets
boolean
Show secrets in plain text
Request body

Execution update request

object
status
string
The current status of the action execution.
result
object
Responses

Execution that was updated

object
id
string
required
trigger
object
trigger_type
object
trigger_instance
object
rule
object
action
object
id
string
The unique identifier for the action.
ref
string
System computed user friendly reference for the action. Provided value will be overridden by computed value.
uid
string
name
string
The name of the action.
required
description
string
The description of the action.
enabled
boolean
Enable or disable the action from invocation.
runner_type
string
The type of runner that executes the action.
required
entry_point
string
The entry point for the action.
pack
string
The content pack this action belongs to.
parameters
object
Input parameters for the action.
tags
array[object]
User associated metadata assigned to this object.
notify
object
Notification settings for action.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
runner
object
liveaction
object
An execution of an action.
id
string
The unique identifier for the action execution.
status
string
The current status of the action execution.
start_timestamp
string
The start time when the action is executed.
end_timestamp
string
The timestamp when the action has finished.
action
string
Reference to the action to be executed.
required
action_is_workflow
boolean
Flag indicating workflow action.
parameters
object
Input parameters for the action.
result
object
context
object
callback
object
runner_info
object
notify
object
Notification settings for liveaction.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
task_execution
string
workflow_execution
string
status
string
The current status of the action execution.
start_timestamp
string
The start time when the action is executed.
end_timestamp
string
The timestamp when the action has finished.
elapsed_seconds
number
Time duration in seconds taken for completion of this execution.
web_url
string
History URL for this execution if you want to view in UI.
parameters
object
Input parameters for the action.
context
object
result
object
parent
string
children
array[string]
log
array[object]
Contains information about execution state transitions.
timestamp
string
status
string

Cancel an execution.

Path parameters
id
string
Entity id
required
Query parameters
show_secrets
boolean
Show secrets in plain text
Responses

Execution cancelled

null
Path parameters
id
string
Entity id
required
attribute
string
Attribute to fetch
required
Responses

Execution attribute requested

null
Path parameters
id
string
Entity id
required
Query parameters
depth
integer
Depth to fetch
result_fmt
string
Result format
Responses

Execution attribute requested

array[object]
id
string
required
trigger
object
trigger_type
object
trigger_instance
object
rule
object
action
object
id
string
The unique identifier for the action.
ref
string
System computed user friendly reference for the action. Provided value will be overridden by computed value.
uid
string
name
string
The name of the action.
required
description
string
The description of the action.
enabled
boolean
Enable or disable the action from invocation.
runner_type
string
The type of runner that executes the action.
required
entry_point
string
The entry point for the action.
pack
string
The content pack this action belongs to.
parameters
object
Input parameters for the action.
tags
array[object]
User associated metadata assigned to this object.
notify
object
Notification settings for action.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
runner
object
liveaction
object
An execution of an action.
id
string
The unique identifier for the action execution.
status
string
The current status of the action execution.
start_timestamp
string
The start time when the action is executed.
end_timestamp
string
The timestamp when the action has finished.
action
string
Reference to the action to be executed.
required
action_is_workflow
boolean
Flag indicating workflow action.
parameters
object
Input parameters for the action.
result
object
context
object
callback
object
runner_info
object
notify
object
Notification settings for liveaction.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
task_execution
string
workflow_execution
string
status
string
The current status of the action execution.
start_timestamp
string
The start time when the action is executed.
end_timestamp
string
The timestamp when the action has finished.
elapsed_seconds
number
Time duration in seconds taken for completion of this execution.
web_url
string
History URL for this execution if you want to view in UI.
parameters
object
Input parameters for the action.
context
object
result
object
parent
string
children
array[string]
log
array[object]
Contains information about execution state transitions.
timestamp
string
status
string

Retrieve execution output.

Path parameters
id
string
Execution id
required
Query parameters
output_type
string
Type of output to retrieve (stdout, stderr). If not provided, all output type is returned.
Responses

Execution output.

null

Create a new execution.

Path parameters
id
string
Entity id
required
Query parameters
show_secrets
boolean
Show secrets in plain text
Request body

Execution request

object
parameters
object
tasks
array
reset
array
user
string
Responses

Single action being created

object
id
string
required
trigger
object
trigger_type
object
trigger_instance
object
rule
object
action
object
id
string
The unique identifier for the action.
ref
string
System computed user friendly reference for the action. Provided value will be overridden by computed value.
uid
string
name
string
The name of the action.
required
description
string
The description of the action.
enabled
boolean
Enable or disable the action from invocation.
runner_type
string
The type of runner that executes the action.
required
entry_point
string
The entry point for the action.
pack
string
The content pack this action belongs to.
parameters
object
Input parameters for the action.
tags
array[object]
User associated metadata assigned to this object.
notify
object
Notification settings for action.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
runner
object
liveaction
object
An execution of an action.
id
string
The unique identifier for the action execution.
status
string
The current status of the action execution.
start_timestamp
string
The start time when the action is executed.
end_timestamp
string
The timestamp when the action has finished.
action
string
Reference to the action to be executed.
required
action_is_workflow
boolean
Flag indicating workflow action.
parameters
object
Input parameters for the action.
result
object
context
object
callback
object
runner_info
object
notify
object
Notification settings for liveaction.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
task_execution
string
workflow_execution
string
status
string
The current status of the action execution.
start_timestamp
string
The start time when the action is executed.
end_timestamp
string
The timestamp when the action has finished.
elapsed_seconds
number
Time duration in seconds taken for completion of this execution.
web_url
string
History URL for this execution if you want to view in UI.
parameters
object
Input parameters for the action.
context
object
result
object
parent
string
children
array[string]
log
array[object]
Contains information about execution state transitions.
timestamp
string
status
string