/
get/api/v1/
actionalias
get/api/v1/actionalias
post/api/v1/actionalias
get/api/v1/actionalias/help
post/api/v1/actionalias/match
get/api/v1/actionalias/{ref_or_id}
put/api/v1/actionalias/{ref_or_id}
delete/api/v1/actionalias/{ref_or_id}
actions
get/api/v1/actions
post/api/v1/actions
get/api/v1/actions/views/entry_point/{ref_or_id}
get/api/v1/actions/views/overview
get/api/v1/actions/views/overview/{ref_or_id}
get/api/v1/actions/views/parameters/{ref_or_id}
get/api/v1/actions/{ref_or_id}
put/api/v1/actions/{ref_or_id}
delete/api/v1/actions/{ref_or_id}
post/api/v1/actions/{ref_or_id}/clone
aliasexecution
post/api/v1/aliasexecution
post/api/v1/aliasexecution/match_and_execute
apikeys
get/api/v1/apikeys
post/api/v1/apikeys
get/api/v1/apikeys/{api_key_id_or_key}
put/api/v1/apikeys/{api_key_id_or_key}
delete/api/v1/apikeys/{api_key_id_or_key}
config_schemas
get/api/v1/config_schemas
get/api/v1/config_schemas/{pack_ref}
configs
get/api/v1/configs
get/api/v1/configs/{pack_ref}
put/api/v1/configs/{pack_ref}
executions
get/api/v1/executions
post/api/v1/executions
get/api/v1/executions/views/filters
get/api/v1/executions/{id}
put/api/v1/executions/{id}
delete/api/v1/executions/{id}
get/api/v1/executions/{id}/attribute/{attribute}
get/api/v1/executions/{id}/children
get/api/v1/executions/{id}/output
post/api/v1/executions/{id}/re_run
get/api/v1/executions/{id}/result
inquiries
get/api/v1/inquiries
get/api/v1/inquiries/{inquiry_id}
put/api/v1/inquiries/{inquiry_id}
keys
get/api/v1/keys
get/api/v1/keys/{name}
put/api/v1/keys/{name}
delete/api/v1/keys/{name}
packs
get/api/v1/packs
get/api/v1/packs/index
get/api/v1/packs/index/health
post/api/v1/packs/index/search
post/api/v1/packs/install
post/api/v1/packs/register
post/api/v1/packs/uninstall
get/api/v1/packs/views/file/{ref_or_id}/{file_path}
get/api/v1/packs/views/files/{ref_or_id}
get/api/v1/packs/{ref_or_id}
policies
get/api/v1/policies
post/api/v1/policies
get/api/v1/policies/{ref_or_id}
put/api/v1/policies/{ref_or_id}
delete/api/v1/policies/{ref_or_id}
policytypes
get/api/v1/policytypes
get/api/v1/policytypes/{ref_or_id}
rbac
get/api/v1/rbac/permission_types
get/api/v1/rbac/permission_types/{resource_type}
get/api/v1/rbac/role_assignments
get/api/v1/rbac/role_assignments/{id}
get/api/v1/rbac/roles
get/api/v1/rbac/roles/{name_or_id}
ruleenforcements
get/api/v1/ruleenforcements
get/api/v1/ruleenforcements/views
get/api/v1/ruleenforcements/views/{id}
get/api/v1/ruleenforcements/{id}
rules
get/api/v1/rules
post/api/v1/rules
get/api/v1/rules/views
get/api/v1/rules/views/{ref_or_id}
get/api/v1/rules/{ref_or_id}
put/api/v1/rules/{rule_ref_or_id}
delete/api/v1/rules/{rule_ref_or_id}
ruletypes
get/api/v1/ruletypes
get/api/v1/ruletypes/{id}
runnertypes
get/api/v1/runnertypes
get/api/v1/runnertypes/{name_or_id}
put/api/v1/runnertypes/{name_or_id}
sensortypes
get/api/v1/sensortypes
get/api/v1/sensortypes/{ref_or_id}
put/api/v1/sensortypes/{ref_or_id}
service_registry
get/api/v1/service_registry/groups
get/api/v1/service_registry/groups/{group_id}/members
timers
get/api/v1/timers
get/api/v1/timers/{ref_or_id}
traces
get/api/v1/traces
get/api/v1/traces/{id}
triggerinstances
get/api/v1/triggerinstances
get/api/v1/triggerinstances/{instance_id}
post/api/v1/triggerinstances/{trigger_instance_id}/re_emit
triggers
get/api/v1/triggers
post/api/v1/triggers
get/api/v1/triggers/{trigger_id}
put/api/v1/triggers/{trigger_id}
delete/api/v1/triggers/{trigger_id}
triggertypes
get/api/v1/triggertypes
post/api/v1/triggertypes
get/api/v1/triggertypes/{triggertype_ref_or_id}
put/api/v1/triggertypes/{triggertype_ref_or_id}
delete/api/v1/triggertypes/{triggertype_ref_or_id}
user
get/api/v1/user
webhooks
get/api/v1/webhooks
post/api/v1/webhooks/{hook}
get/api/v1/webhooks/{url}
workflows
post/api/v1/workflows/inspect
sso
get/auth/v1/sso
post/auth/v1/sso/callback
get/auth/v1/sso/request
tokens
post/auth/v1/tokens
post/auth/v1/tokens/validate
executions
get/stream/v1/executions/{id}/output
stream
get/stream/v1/stream
v1aliasexecution
post/api/v1/aliasexecution

Create alias execution.

Query parameters
show_secrets
boolean
Show secrets in plain text
Request body

Alias execution payload.

object
actionalias
object
Alias for an action
id
string
Unique identifier for the action alias.
ref
string
System computed user friendly reference for the alias. Provided value will be overridden by computed value.
uid
string
name
string
Name of the action alias.
pack
string
The content pack this actionalias belongs to.
description
string
Description of the executed alias.
enabled
boolean
Flag indicating if action alias is enabled.
action_ref
string
Reference to the aliased action
formats
array
Possible parameter format.
ack
object
Acknowledgement message format.
enabled
boolean
format
string
extra
object
append_url
boolean
result
object
Execution message format.
enabled
boolean
format
string
extra
object
extra
object
Extra parameters, usually adapter-specific
delay
integer
How long (in milliseconds) to delay the execution before scheduling.
execution
object
Execution result
id
string
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.
delay
integer
How long (in milliseconds) to delay the execution before scheduling.
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
result_size
integer
parent
string
children
array[string]
log
array[object]
Contains information about execution state transitions.
timestamp
string
status
string
delay
integer
How long (in milliseconds) to delay the execution before scheduling.
message
string
Responses

Action alias created

object
actionalias
object
Alias for an action
id
string
Unique identifier for the action alias.
ref
string
System computed user friendly reference for the alias. Provided value will be overridden by computed value.
uid
string
name
string
Name of the action alias.
pack
string
The content pack this actionalias belongs to.
description
string
Description of the executed alias.
enabled
boolean
Flag indicating if action alias is enabled.
action_ref
string
Reference to the aliased action
formats
array
Possible parameter format.
ack
object
Acknowledgement message format.
enabled
boolean
format
string
extra
object
append_url
boolean
result
object
Execution message format.
enabled
boolean
format
string
extra
object
extra
object
Extra parameters, usually adapter-specific
delay
integer
How long (in milliseconds) to delay the execution before scheduling.
execution
object
Execution result
id
string
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.
delay
integer
How long (in milliseconds) to delay the execution before scheduling.
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
result_size
integer
parent
string
children
array[string]
log
array[object]
Contains information about execution state transitions.
timestamp
string
status
string
delay
integer
How long (in milliseconds) to delay the execution before scheduling.
message
string
post/api/v1/aliasexecution/match_and_execute

Create executions based on action alias match (if any).

Query parameters
show_secrets
boolean
Show secrets in plain text
Request body

Input data.

object
command
string
Command string to parse (eg: message from chat)
required
user
string
User that requested the execution (or messaged in chat)
required
source_channel
string
Channel the message is from (different than the notification channel)
required
notification_channel
string
StackStorm notification channel to use to respond
notification_route
string
StackStorm notification route to use to respond
Responses

Action alias executions created

object
results
array[object]
List of all matched and executed actions
actionalias
object
Alias for an action
id
string
Unique identifier for the action alias.
ref
string
System computed user friendly reference for the alias. Provided value will be overridden by computed value.
uid
string
name
string
Name of the action alias.
pack
string
The content pack this actionalias belongs to.
description
string
Description of the executed alias.
enabled
boolean
Flag indicating if action alias is enabled.
action_ref
string
Reference to the aliased action
formats
array
Possible parameter format.
ack
object
Acknowledgement message format.
enabled
boolean
format
string
extra
object
append_url
boolean
result
object
Execution message format.
enabled
boolean
format
string
extra
object
extra
object
Extra parameters, usually adapter-specific
delay
integer
How long (in milliseconds) to delay the execution before scheduling.
execution
object
Execution result
id
string
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.
delay
integer
How long (in milliseconds) to delay the execution before scheduling.
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
result_size
integer
parent
string
children
array[string]
log
array[object]
Contains information about execution state transitions.
timestamp
string
status
string
delay
integer
How long (in milliseconds) to delay the execution before scheduling.
message
string