StackStorm API Reference

api

v1

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}

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

post/api/v1/aliasexecution

post/api/v1/aliasexecution/match_and_execute

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}

get/api/v1/config_schemas

get/api/v1/config_schemas/{pack_ref}

get/api/v1/configs

get/api/v1/configs/{pack_ref}

put/api/v1/configs/{pack_ref}

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

get/api/v1/inquiries

get/api/v1/inquiries/{inquiry_id}

put/api/v1/inquiries/{inquiry_id}

get/api/v1/keys

get/api/v1/keys/{name}

put/api/v1/keys/{name}

delete/api/v1/keys/{name}

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}

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}

get/api/v1/policytypes

get/api/v1/policytypes/{ref_or_id}

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}

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}

get/api/v1/ruletypes

get/api/v1/ruletypes/{id}

get/api/v1/runnertypes

get/api/v1/runnertypes/{name_or_id}

put/api/v1/runnertypes/{name_or_id}

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

get/api/v1/timers

get/api/v1/timers/{ref_or_id}

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

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}

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}

get/api/v1/user

get/api/v1/webhooks

post/api/v1/webhooks/{hook}

get/api/v1/webhooks/{url}

post/api/v1/workflows/inspect

auth

v1

get/auth/v1/sso

post/auth/v1/sso/callback

get/auth/v1/sso/request

post/auth/v1/tokens

post/auth/v1/tokens/validate

stream

v1

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

get/stream/v1/stream

v1webhooks

get/api/v1/webhooks

Returns a list of all webhooks.

Responses

200default

List of webhooks

array[object]

post/api/v1/webhooks/{hook}

Trigger a webhook.

Path parameters

hook

string

Webhook path

required

Request body

Webhook payload

object, array

Responses

202default

Single action being created

object, array

get/api/v1/webhooks/{url}

Get one action.

Path parameters

url

string

Webhook relative URL path

required

Responses

200default

Action requested

object