Start

Platform

Agents

App store purchases

Auth

Builds

Credits

Database

Flags

Generated Assets

Hosting

Jobs and cron

Knowledge

Localization

Monitoring

Network

Notifications

Organizations

Queues

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 distributed_jobs

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

Checked 2026-09-28

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

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

#get

Gets a distributed job.

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

CLI

Shell

sylphx workflows distributed-jobs get orgs/acme/projects/shop/envs/production/distributed_jobs/distributed-job

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

#list

Lists distributed jobs.

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

CLI

Shell

sylphx workflows distributed-jobs list orgs/acme/projects/shop/envs/production

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

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

CLI

Shell

sylphx workflows distributed-jobs create --parent orgs/acme/projects/shop/envs/production --spec.worker.service …

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/distributed_jobs · 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.worker.service`	`string`	The Hosting Service whose env and Secret bindings every run takes, and whose live Release image it runs unless `image` or `build` names another, so a Job never runs code the environment does not serve. Required.
`--spec.worker.image`	`string`	A digest-pinned image from this org's Artifacts, in place of the service's image. Exclusive with `build`.
`--spec.worker.command`	`string`	The entrypoint; empty keeps the image's. Repeat the flag for each value.
`--spec.worker.args`	`string`	Arguments; a run may replace them. Repeat the flag for each value.
`--spec.worker.env`	`key=value`	Environment overrides on top of the service's env and Secret bindings. Repeat the flag for each value.
`--spec.worker.instance-type`	`string`	A Hosting instance type; default `standard`.
`--spec.worker.timeout`	`duration`	One attempt's deadline, 10s to 24h; default 1h.
`--spec.worker.max-retries`	`int`	Re-runs after a non-zero exit, 0 to 10; backoff 30s doubling.
`--spec.worker.concurrency`	`enum`	What a start does while a run is active; default forbid. One of `forbid`, `queue`, `allow`.
`--spec.worker.build`	`string`	A build the project declares: its latest built image, in place of the service's; the image needs no running service of its own. Exclusive with `image`.
`--spec.worker-class`	`enum`	Price and preemption class; default scavenger. One of `scavenger`, `standard`.
`--spec.scale.min-workers`	`int`	Workers kept while shards remain; default 1.
`--spec.scale.max-workers`	`int`	The most workers at once; the Cell and the org quota cap it too. Default 1.
`--spec.scratch-gib`	`int`	Local scratch disk at `/scratch` per worker, GiB; 0 is none.
`--spec.shard-count`	`int`	A run that brings no shards of its own gets this many index-only shards.
`--spec.shard-timeout`	`duration`	The longest one lease may live without the shard ending; default 30m.
`--spec.shard-retries`	`int`	Attempts a shard gets after a failure; a preemption is not one. Default 3.
`--spec.max-failed-shards`	`int`	Failed shards the run tolerates before it fails; default 0.
`--spec.run-timeout`	`duration`	The whole run's deadline; default 48h.
`--spec.checkpoint-uri`	`string`	`data://<bucket>/<prefix>/`: checkpoints go under `<run>/<shard>/`.
`--spec.output-uri`	`string`	`data://<bucket>/<prefix>/`: outputs go under `<run>/<shard>/`.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).
`--no-wait`	`bool`	Return the call at once instead of waiting for it to finish.

#update

Updates a distributed job. Runs already started keep the generation they pinned.

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

CLI

Shell

sylphx workflows distributed-jobs update orgs/acme/projects/shop/envs/production/distributed_jobs/distributed-job --spec.worker.service …

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/distributed_jobs/distributed-job · 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.worker.service`	`string`	The Hosting Service whose env and Secret bindings every run takes, and whose live Release image it runs unless `image` or `build` names another, so a Job never runs code the environment does not serve. Required.
`--spec.worker.image`	`string`	A digest-pinned image from this org's Artifacts, in place of the service's image. Exclusive with `build`.
`--spec.worker.command`	`string`	The entrypoint; empty keeps the image's. Repeat the flag for each value.
`--spec.worker.args`	`string`	Arguments; a run may replace them. Repeat the flag for each value.
`--spec.worker.env`	`key=value`	Environment overrides on top of the service's env and Secret bindings. Repeat the flag for each value.
`--spec.worker.instance-type`	`string`	A Hosting instance type; default `standard`.
`--spec.worker.timeout`	`duration`	One attempt's deadline, 10s to 24h; default 1h.
`--spec.worker.max-retries`	`int`	Re-runs after a non-zero exit, 0 to 10; backoff 30s doubling.
`--spec.worker.concurrency`	`enum`	What a start does while a run is active; default forbid. One of `forbid`, `queue`, `allow`.
`--spec.worker.build`	`string`	A build the project declares: its latest built image, in place of the service's; the image needs no running service of its own. Exclusive with `image`.
`--spec.worker-class`	`enum`	Price and preemption class; default scavenger. One of `scavenger`, `standard`.
`--spec.scale.min-workers`	`int`	Workers kept while shards remain; default 1.
`--spec.scale.max-workers`	`int`	The most workers at once; the Cell and the org quota cap it too. Default 1.
`--spec.scratch-gib`	`int`	Local scratch disk at `/scratch` per worker, GiB; 0 is none.
`--spec.shard-count`	`int`	A run that brings no shards of its own gets this many index-only shards.
`--spec.shard-timeout`	`duration`	The longest one lease may live without the shard ending; default 30m.
`--spec.shard-retries`	`int`	Attempts a shard gets after a failure; a preemption is not one. Default 3.
`--spec.max-failed-shards`	`int`	Failed shards the run tolerates before it fails; default 0.
`--spec.run-timeout`	`duration`	The whole run's deadline; default 48h.
`--spec.checkpoint-uri`	`string`	`data://<bucket>/<prefix>/`: checkpoints go under `<run>/<shard>/`.
`--spec.output-uri`	`string`	`data://<bucket>/<prefix>/`: outputs go under `<run>/<shard>/`.
`--allow-missing`	`bool`	Create the distributed job when it does not exist (declarative upsert).
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).
`--no-wait`	`bool`	Return the call at once instead of waiting for it to finish.

#delete

Deletes a distributed job.

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

CLI

Shell

sylphx workflows distributed-jobs delete orgs/acme/projects/shop/envs/production/distributed_jobs/distributed-job --yes

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/distributed_jobs/distributed-job · 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 distributed job does not exist.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).
`--force`	`bool`	Also cancel active runs; without it a job with an active run fails with INVALID_STATE.
`--no-wait`	`bool`	Return the call at once instead of waiting for it to finish.
`--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