Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Distributed jobs

A DistributedJob runs one container image on many workers at once.

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.

A DistributedJob runs one container image on many workers at once. A run splits its work into shards that workers lease from a queue; the worker pool grows and shrinks with the capacity Kueue admits, and a preempted shard goes back to the queue.

Service Sylphx Workflows · Resource type workflows.sylphx.com/DistributedJob · Name pattern orgs/{org}/projects/{project}/envs/{env}/distributed_jobs/{distributed_job} · Shape spec_status

#Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/distributed_jobs/{distributed_job}.
uidstringdjob_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specDistributedJobSpecDesired state. Required.
statusDistributedJobStatusObserved state. Output only.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets a distributed job.
GETlistLists distributed jobs.
POSTcreateCreates a distributed job.
PATCHupdateUpdates a distributed job. Runs already started keep the generation they pinned.
DELETEdeleteDeletes a distributed job.

#get

Gets a 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.

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

#create

Creates a distributed job.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/distributed_jobs · scope workflows:write · effect write · long-running · Request, response and examples

#update

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

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

#delete

Deletes a distributed job.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/distributed_jobs/distributed-job · scope workflows:write · effect destructive · long-running · Request, response and examples