Docs

zitadel flow-definitions get

Get one flow definition by flow name (newest revision) or revision id.

Usage

npx @zitadel/cli@latest flow-definitions get <flow> [flags]

Arguments

ArgumentDescription
<flow>flow name (newest revision) or revision id Required.

Flags

FlagDescription
--fields <value>Fields to show, comma-separated dot-paths. Defaults to the resource's own; --json is unaffected.
-e, --env <value>Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then development.
--env-file <value>Read ZITADEL_* values from this file ahead of the process environment. A relative path is read from the current directory, not from --cwd. Cannot be combined with --env.

It also takes the global flags.

Examples

npx @zitadel/cli@latest flow-definitions get <flow>
npx @zitadel/cli@latest flow-definitions get <flow> --json

API

It calls Get a flow definition by id, GET /flow_definitions/{id}, in the Flow definitions API.

Was this helpful?