Skip to main content

Python client library and CLI for the StackStorm (st2) event-driven automation platform.

Project description

Install stable / production version from Python Package Index (PyPi)

pip install st2client

Install latest development version from Source

Git clone StackStorm/st2 repo locally, change directory to st2client, then run “python install” or install it directly using pip from git:

pip install "git+"

Endpoint Configuration

By default, both the python client and the CLI will retrieve endpoint configuration from the environment. If no configuration is provided, the client will assume localhost and default ports.

  • ST2_BASE_URL - Base URL for the StackStorm API server endpoints (i.e. If only the base URL is provided, the client will assume default ports for the API servers are used. If any of the API server URL is provided, it will override the base URL and default port.

  • ST2_AUTH_URL - URL to the auth API endpoint used for authentication.

  • ST2_API_URL - Endpoint for the Action REST API (i.e. for managing actions, executions, triggers, rules and other resources.

  • ST2_STREAM_URL - URL to the stream API endpoind uses for event-stream data.

The default endpoint configuration can be explicitly specified at the StackStorm CLI and the python client. For StackStorm CLI, the endpoints are provided via optional parameters (i.e. --url for base URL, --auth-url, --api-url and --stream-url).

For the python client, the endpoints are provided via the Client init as kwargs (i.e. base_url, auth_url, api_url, stream_url).


CLI is developed using standard python argparse and uses well known pattern for commands and subcommands. In general, trigger, rule, action, and key are commands and list, get, create, update, and delete are subcommands. The command run and execution are special cases and do not have the same set of subcommands. Please use the CLI help option for more detail description.

-h or –help option is used to display usage information.

st2 -h
st2 action -h
st2 action create -h
st2 run -h
st2 run <action-ref> -h

-j or --json option will format output as JSON.

st2 rule get <rule-name> -j

-y or --yaml option will format output as YAML.

st2 rule get <rule-name> -j

-a or --attr option allows user to specify which attributes to display and in which order.

st2 rule get <rule-name> -a name description
st2 execution list --attr id action.ref status start_timestamp

-w or --width option lets user specify the width of table columns. If only 1 value is provided, all table columns will have the same width. By default, the width is 28.

st2 rule list -a name description -w 50
st2 rule list -a name description -w 25 50

Python Client

>>> from st2client.client import Client
>>> from st2client import models
>>> client = Client(base_url='')
>>> rules = client.rules.get_all()
>>> executions = client.executions.get_all()
>>> key_value_pair = client.keys.update(models.KeyValuePair(name='k1', value='v1'))

The models Trigger, Rule, Action, Execution, and KeyValuePair are defined under st2client.models. Please refer to the respective README section for these models for their schema.

The resource managers for the models are instantiated under the client as triggers, rules, actions, executions, and keys. The operations get_all, get_by_name, get_by_id, create, update, and delete are generally implemented for these resource managers.

  • get_all returns a list of resource instances.

  • get_by_name and get_by_id takes name and id respectively and returns the matching resource instance.

  • create takes a resource instance as input and creates the instance, throwing unique constraint error if name already exists

  • update takes a resource instance as input and updates the instance matching by name

  • delete takes a resource instance as input and deletes the instance matching by name

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

st2client-3.8.1.tar.gz (117.6 kB view hashes)

Uploaded Source

Built Distribution

st2client-3.8.1-py3-none-any.whl (185.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page