Skip to main content

​
What Cymph uses it for

Cymph connects to StackStorm as a deployment target — playbooks authored in Cymph are translated to StackStorm workflows and pushed to the instance. See Deploy playbooks.

​
Requirements

​
API key setup

All API key management is currently available via the StackStorm CLI or API. To create an API key:
You can read more detailed documentation here.

​
Permissions

A StackStorm API key inherits the permissions of the user that created it, so create the key as a dedicated user with a role granting only what Cymph uses: You do not need action_execute — Cymph deploys playbooks but never runs them — and no action_delete.
Create, modify, delete, and execute grants implicitly include the matching view permission, so action_create and action_modify already cover action_view. You only need to add action_list on top.
Grants can be scoped to a specific pack by UID (pack:my_pack) rather than granted globally, which is the tighter option if Cymph deploys into a pack of its own.
RBAC is available in StackStorm open source from 3.4 onward — it was an enterprise feature before that. On an older or non-RBAC instance, any valid API key has full access and these grants do not apply.

​
What Cymph reads and writes

​
Testing the connection