/
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
v1packs
get/api/v1/packs

Get list of installed packs.

Query parameters
exclude_attributes
array[string]
List of attributes to exclude
include_attributes
array[string]
List of attributes to include
limit
integer
Number of packs to get
offset
integer
Number of packs to offset
sort
string
Comma-separated list of fields to sort by
id
array[string]
Entity id filter
name
string
Entity name filter
ref
string
Entity ref filter
Responses

List of installed packs.

array[object]
author
string
Author of the pack.
description
string
Description of the pack.
name
string
Name of the pack.
ref
string
Reference of the pack.
version
string
Version of the pack.
content
object
Content type in the pack.
keywords
array[string]
Keywords associated with the pack.
repo_url
string
URL of the Pack's repo.
get/api/v1/packs/index

To list all the packs of all indexes used by your StackStorm instance.

Responses

Pack index.

object
indexes
object
Index details.
count
integer
Number of index.
errors
object
Errors.
invalid
integer
Invalid.
status
array
Status of the index.
valid
integer
Valid.
packs
object
Number of packs in the index.
get/api/v1/packs/index/health

To get the state of all indexes used by your StackStorm instance.

Responses

Index health.

object
indexes
object
Index details.
count
integer
Number of index.
errors
object
Errors.
invalid
integer
Invalid.
status
array
Status of the index.
valid
integer
Valid.
packs
object
Number of packs in the index.
post/api/v1/packs/index/search

Search the index with a query or Get information about an available pack from the index.

Request body

A query to search a pack or a pack name to get its details

object
pack
string
Name of the pack to show.
query
string
Search query.
Responses

Pack search results.

array, object
post/api/v1/packs/install

Install new packs..

Request body

Packs to be installed

object
packs
array[string]
ref of the packs in Exchange, or a git repo URL.
required
force
boolean
Force pack installation.
skip_dependencies
boolean
Set to True to skip pack dependency installations.
Responses

Pack installation request has been accepted

object
execution_id
string
required
post/api/v1/packs/register

Register pack(s): sync all file changes with DB.

Request body

Pack(s) to be Registered

object
packs
array[string]
ref of the packs in Exchange, or a git repo URL.
types
array[string]
Types of content to register.
fail_on_failure
boolean
True to fail on failure
Responses

Pack(s) Registered.

object
author
string
Author of the pack.
description
string
Description of the pack.
name
string
Name of the pack.
ref
string
Reference of the pack.
version
string
Version of the pack.
content
object
Content type in the pack.
keywords
array[string]
Keywords associated with the pack.
repo_url
string
URL of the Pack's repo.
post/api/v1/packs/uninstall

Uninstall packs.

Request body

Packs to be uninstalled

object
ref_or_id
string
ref or id of the pack
packs
array[string]
Name of the packs in Exchange, or a git repo URL.
Responses

Pack uninstallation request has been accepted

object
execution_id
string
required
get/api/v1/packs/views/file/{ref_or_id}/{file_path}

Get information about an installed pack.

Path parameters
ref_or_id
string
Reference of the pack.
required
file_path
string
Path to the file.
required
Header parameters
if-none-match
string
ETag to compare to.
if-modified-since
string
Date of last known modification.
Responses

Content of the file.

null
get/api/v1/packs/views/files/{ref_or_id}

Get information about an installed pack.

Path parameters
ref_or_id
string
Reference of the pack.
required
Responses

Information about a pack.

array[object]
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
get/api/v1/packs/{ref_or_id}

Get information about an installed pack.

Path parameters
ref_or_id
string
Reference of the pack.
required
Responses

Information about a pack.

object
author
string
Author of the pack.
description
string
Description of the pack.
email
string
Email of the author.
keywords
array[string]
Keywords associated with the pack.
name
string
Name of the pack.
version
string
Version of the pack.