Console

Start

Platform

App store purchases

Auth

Builds

Database

Flags

Hosting

Jobs and cron

Localization

Monitoring

Network

Notifications

Organizations

Payments

Queues

Events

Realtime

Runners

Sandboxes

Storage

Webhooks

Workflows

Getting Started

Installation

Authentication

AI Services

KV Store

Overview

Webhooks

Deploy & Infrastructure

Reference

On this page

get
list
create
update
delete

Reference

sylphx workflows workflows

Every sylphx workflows workflows command: its argument, its flags and a run line.

Checked 2026-09-28

The workflows commands of Sylphx Workflows, as the CLI spells them: the same calls as the workflows API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

#get

Gets a workflow.

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

CLI

Shell

sylphx workflows workflows get orgs/acme/projects/shop/envs/production/workflows/workflow

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

#list

Lists workflows.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell

sylphx workflows workflows list orgs/acme/projects/shop/envs/production

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows · 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.

#create

Creates a workflow.

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

CLI

Shell

sylphx workflows workflows create --parent orgs/acme/projects/shop/envs/production

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows · scope workflows:write · 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.
`--spec.handler-uri`	`string`	An HTTPS URI on port 443 whose host is a verified Network Domain of this project or a Hosting route the project owns.
`--spec.service-handler.service`	`string`	The Hosting Service in the same environment.
`--spec.service-handler.path`	`string`	The request path, for example `/api/sylphx/workflows`.
`--spec.retry-policy.max-attempts`	`int`	Attempts per step, 1 to 100; default 10.
`--spec.retry-policy.initial-interval`	`duration`	The first backoff; default 1s.
`--spec.retry-policy.backoff-coefficient`	`number`	Backoff growth, 1.0 to 10.0; default 2.0.
`--spec.retry-policy.max-interval`	`duration`	The largest backoff; default 10m.
`--spec.timeouts.invocation-timeout`	`duration`	One handler invocation, 1s to 900s; default 60s.
`--spec.timeouts.run-timeout`	`duration`	The whole Run, at most 365d; default 30d.
`--spec.max-concurrent-runs`	`int`	At most this many running Runs of this Workflow; 0 is unlimited within the plan.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).

#update

Updates a workflow.

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

CLI

Shell

sylphx workflows workflows update orgs/acme/projects/shop/envs/production/workflows/workflow

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

Flags

Flag	Type	What it does
`--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.
`--spec.handler-uri`	`string`	An HTTPS URI on port 443 whose host is a verified Network Domain of this project or a Hosting route the project owns.
`--spec.service-handler.service`	`string`	The Hosting Service in the same environment.
`--spec.service-handler.path`	`string`	The request path, for example `/api/sylphx/workflows`.
`--spec.retry-policy.max-attempts`	`int`	Attempts per step, 1 to 100; default 10.
`--spec.retry-policy.initial-interval`	`duration`	The first backoff; default 1s.
`--spec.retry-policy.backoff-coefficient`	`number`	Backoff growth, 1.0 to 10.0; default 2.0.
`--spec.retry-policy.max-interval`	`duration`	The largest backoff; default 10m.
`--spec.timeouts.invocation-timeout`	`duration`	One handler invocation, 1s to 900s; default 60s.
`--spec.timeouts.run-timeout`	`duration`	The whole Run, at most 365d; default 30d.
`--spec.max-concurrent-runs`	`int`	At most this many running Runs of this Workflow; 0 is unlimited within the plan.
`--allow-missing`	`bool`	Create the workflow when it does not exist (declarative upsert).
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).

#delete

Deletes a workflow.

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

CLI

Shell

sylphx workflows workflows delete orgs/acme/projects/shop/envs/production/workflows/workflow --yes

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

Flags

Flag	Type	What it does
`--etag`	`string`	Delete only if the current etag matches.
`--allow-missing`	`bool`	Succeed when the workflow does not exist.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).
`--force`	`bool`	Also cancel and delete the Workflow's Runs and Schedules; without it a Workflow with open Runs or Schedules fails with INVALID_STATE.
`--yes`	`bool`	Do not ask before this destructive call.

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links