Skip to content
Console
On this page

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

Shell
sylphx workflows runs get orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run

GET 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

Shell
sylphx workflows runs list orgs/acme/projects/shop/envs/production/workflows/workflow

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow/runs · scope workflows:read · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--page-sizeintAt most this many; default 50, clamped to 1000.
--page-tokenstringnext_page_token of the previous page.
--filterstringAIP-160 filter over labels and filterable fields.
--order-bystringAIP-132 ordering over filterable fields.

start

Starts a Run of a Workflow, now or after start_delay or at schedule_time. run_id is the caller's key: the same key and intent return the same Run, a changed intent is refused. An end user's session may call it on a Workflow whose callers is USERS when the session holds the Workflow's permission.

ID — The id segment of the new Resource's name; the server assigns one when omitted.

CLI

Shell
sylphx workflows runs start --parent orgs/acme/projects/shop/envs/production/workflows/workflow

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow/runs · scope workflows:run · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--parentstringThe parent to create in; defaults to the linked project or the key's scope.
--meta.labelskey=valueCaller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
--meta.annotationskey=valueCaller-writable, unindexed annotations. Repeat the flag for each value.
--meta.display-namestringCaller-writable human-readable name.
--inputjsonThe Run input, at most 256 KiB of JSON.
--start-delaydurationDelay the first invocation by this much.
--schedule-timetimestampWhen 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-runboolValidate 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

Shell
sylphx workflows runs start-batch orgs/acme/projects/shop/envs/production/workflows/workflow

POST 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

FlagTypeWhat it does
--inputsjsonThe inputs, one child Run each; at most 10 000. Required. Repeat the flag for each value.
--max-concurrencyintAt 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. An end user's session may call it on a Workflow whose callers is USERS when the session holds the Workflow's permission.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx workflows runs signal orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run

POST 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

FlagTypeWhat it does
--signalstringThe signal name the handler waits on. Required.
--payloadjsonThe 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. An end user's session may call it on a Workflow whose callers is USERS when the session holds the Workflow's permission.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx workflows runs cancel orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run --yes

POST 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

FlagTypeWhat it does
--reasonstringWhy the Run is cancelled.
--yesboolDo 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. Its short name is result: the closed Run carries the handler's output or error. An end user's session may call it on a Workflow whose callers is USERS when the session holds the Workflow's permission.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx workflows runs wait orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run

POST 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

FlagTypeWhat it does
--timeoutdurationHow 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

Shell
sylphx workflows runs read-history orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run

GET 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

FlagTypeWhat it does
--page-sizeintAt most this many; default 100, clamped to 1000.
--page-tokenstringnext_page_token of the previous page.