Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
sylphx workflows runs
Every sylphx workflows runs command: its argument, its flags and a run line.
The runs commands of Sylphx Workflows, as the CLI spells them: the same
calls as the runs API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets a run.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx workflows runs get orgs/acme/projects/shop/envs/production/workflows/workflow/runs/runGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run · scope workflows:read · effect read · Request, response and examples
#list
Lists runs.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx workflows runs list orgs/acme/projects/shop/envs/production/workflows/workflowGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow/runs · scope workflows:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | At most this many; default 50, clamped to 1000. |
--page-token | string | next_page_token of the previous page. |
--filter | string | AIP-160 filter over labels and filterable fields. |
--order-by | string | AIP-132 ordering over filterable fields. |
#start
Starts a Run of a Workflow.
ID — The id segment of the new Resource's name; the server assigns one when omitted.
CLI
sylphx workflows runs start --parent orgs/acme/projects/shop/envs/production/workflows/workflowPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow/runs · scope workflows:run · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--parent | string | The parent to create in; defaults to the linked project or the key's scope. |
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--input | json | The Run input, at most 256 KiB of JSON. |
--start-delay | duration | Delay the first invocation by this much. |
--schedule-time | timestamp | When the first invocation is due: set it directly, or through start_delay; at most 365 days ahead. A Run cancelled before then closes cancelled with no invocation. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#start-batch
Starts a batch: a parent Run that fans out one child Run per item, each with a stable index and count.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx workflows runs start-batch orgs/acme/projects/shop/envs/production/workflows/workflowPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow/runs:startBatch · scope workflows:run · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--inputs | json | The inputs, one child Run each; at most 10 000. Required. Repeat the flag for each value. |
--max-concurrency | int | At most this many children run at once; 0 is the Workflow's limit. |
#signal
Sends a named signal to a running Run; a wait op for that name resumes with its payload. A signal to a closed Run fails with INVALID_STATE.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx workflows runs signal orgs/acme/projects/shop/envs/production/workflows/workflow/runs/runPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run:signal · scope workflows:run · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--signal | string | The signal name the handler waits on. Required. |
--payload | json | The signal payload, at most 64 KiB of JSON. |
#cancel
Requests cancellation. Timers and waits stop; a running invocation is not interrupted: the handler receives one final invocation with cancel: true, and the Run ends cancelled when it answers.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx workflows runs cancel orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run --yesPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run:cancel · scope workflows:run · effect destructive · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--reason | string | Why the Run is cancelled. |
--yes | bool | Do not ask before this destructive call. |
#wait
Waits up to timeout (at most 60s) for the Run to close, then returns it, closed or not.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx workflows runs wait orgs/acme/projects/shop/envs/production/workflows/workflow/runs/runPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run:wait · scope workflows:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--timeout | duration | How long to wait; default 30s, at most 60s. |
#read-history
Reads a page of the Run's immutable history, projected to Sylphx events.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx workflows runs read-history orgs/acme/projects/shop/envs/production/workflows/workflow/runs/runGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run:readHistory · scope workflows:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | At most this many; default 100, clamped to 1000. |
--page-token | string | next_page_token of the previous page. |