st2 run <ref-or-id> <parameters...>

Invoke an action manually

Arguments

NameDescription
ref-or-idReference or ID
parametersList of keyword args, positional args, and optional args for the action

Options

NameDescription
-t, --token <TOKEN>Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default
--api-key <API_KEY>Api Key for user authentication. Get ST2_API_KEY from the environment variables by default
-j, --jsonPrint output in JSON format
-y, --yamlPrint output in YAML format
-h, --helpShow this help and exit
--attr <ATTR...>List of attributes to include in the output. 'all' or unspecified will return all attributes
-d, --detailDisplay full detail of the execution in table format
-k, --key <KEY>If result is type of JSON, then print specific key-value pair; dot notation for nested JSON is supported
--delay <DELAY>How long (in milliseconds) to delay the execution before scheduling
--tailAutomatically start tailing new execution
--auto-dictAutomatically convert list items to dictionaries when colons are detected. (NOTE - this parameter and its functionality will be deprecated in the next release in favor of a more robust conversion method)
--trace-tag, --trace_tag <TRACE_TAG>A trace tag string to track execution later
--trace-id <TRACE_ID>Existing trace id for this execution
-a, --asyncDo not wait for action to finish
-e, --inherit-envPass all the environment variables which are accessible to the CLI as 'env' parameter to the action. Note: Only works with python, local and remote runners
-u, --user <USER>User under which to run the action (admins only)