StackStorm API Reference

api

auth

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

stream

executions

get/stream/v1/executions/{id}/output

stream

get/stream/v1/stream

v1actions

get/api/v1/actions

Returns a list of all actions.

Query parameters

exclude_attributes

array[string]

List of attributes to exclude

include_attributes

array[string]

List of attributes to include

limit

integer

Number of actions to get

offset

integer

Number of actions to offset

array[string]

Action id filter

name

string

Action name filter

pack

string

Action pack name filter

tags

string

Action tags name filter

Responses

200default

List of actions

array[object]

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.

post/api/v1/actions

Create a new action.

Request body

Action content

object

pack

string

The content pack this action belongs to.

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.

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.

data_files

array[object]

Optional action script and data files which are written to the filesystem.

file_path

string

Path to the file relative to the pack actions directory (e.g. my_action.py).

required

content

string

Raw file content.

required

Responses

201default

Single action being created

object

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.

get/api/v1/actions/views/entry_point/{ref_or_id}

Get code of the action's entry_point.

Path parameters

ref_or_id

string

Entity reference or id

required

Responses

200default

Entry point code

string

get/api/v1/actions/views/overview

Returns a list of all the actions with runner parameters included.

Query parameters

exclude_attributes

array[string]

List of attributes to exclude

include_attributes

array[string]

List of attributes to include

limit

integer

Number of actions to get

offset

integer

Number of actions to offset

string

Action id filter

name

string

Action name filter

pack

string

Action pack name filter

Responses

200default

List of actions

array[object]

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.

get/api/v1/actions/views/overview/{ref_or_id}

Get one action with runner parameters included.

Path parameters

ref_or_id

string

Entity reference or id

required

Responses

200default

Action requested

object

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.

get/api/v1/actions/views/parameters/{ref_or_id}

Get parameters for an action.

Path parameters

ref_or_id

string

Entity reference or id

required

Responses

200default

An object containing action parameters

object

parameters

object

Input parameters for the action.

get/api/v1/actions/{ref_or_id}

Get one action.

Path parameters

ref_or_id

string

Entity reference or id

required

Responses

200default

Action requested

object

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.

put/api/v1/actions/{ref_or_id}

Update an action.

Path parameters

ref_or_id

string

Entity reference or id

required

Request body

Action content

object

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.

data_files

array[object]

Optional action script and data files which are written to the filesystem.

file_path

string

Path to the file relative to the pack actions directory (e.g. my_action.py).

required

content

string

Raw file content.

required

Responses

200default

Action updated

object

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.

delete/api/v1/actions/{ref_or_id}

Delete an action.

Path parameters

ref_or_id

string

Entity reference or id

required

Request body

Flag to remove action files from disk

object

remove_files

boolean

Flag to delete action files from disk

Responses

204default

Action deleted

null

post/api/v1/actions/{ref_or_id}/clone

Clone one action.

Path parameters

ref_or_id

string

Source action reference or id

required

Request body

Destination action content

object

dest_pack

string

Destination pack name for cloning

required

dest_action

string

Destination action name for cloning

required

overwrite

boolean

Force clone action if destination already exists

Responses

201default

Single action being cloned

object

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.