/
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
v1rules
get/api/v1/rules

Returns a list of all rules.

Query parameters
exclude_attributes
array[string]
List of attributes to exclude
include_attributes
array[string]
List of attributes to include
limit
integer
Number of entities to get
id
array[string]
Entity id filter
name
string
Entity name filter
pack
string
Entity pack name filter
action
string
Action ref filter
trigger
string
Trigger filter
enabled
string
Enabled filter
show_secrets
boolean
Show secrets in plain text
Responses

List of rules

array[object]
post/api/v1/rules

Create a new rule.

Request body

Rule content

object
Responses

Single action being created

object
get/api/v1/rules/views

Returns a list of all rules.

Query parameters
exclude_attributes
array[string]
List of attributes to exclude
include_attributes
array[string]
List of attributes to include
limit
integer
Number of entities to get
id
array[string]
Entity id filter
name
string
Entity name filter
pack
string
Entity pack name filter
action
string
Action ref filter
trigger
string
Trigger filter
enabled
string
Enabled filter
Responses

List of rules

array[object]
get/api/v1/rules/views/{ref_or_id}

Get one rule.

Path parameters
ref_or_id
string
Entity reference or id
required
Responses

Rule requested

object
get/api/v1/rules/{ref_or_id}

Get one rule.

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

Rule requested

object
put/api/v1/rules/{rule_ref_or_id}

Update a rule.

Path parameters
rule_ref_or_id
string
Entity reference or id
required
Request body

Rule content

object
Responses

Action updated

object
delete/api/v1/rules/{rule_ref_or_id}

Delete a rule.

Path parameters
rule_ref_or_id
string
Entity reference or id
required
Responses

Rule deleted

null