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
Jobs
A Job runs a container to completion: the project's image, a command, an exit status, logs, and metered usage.
A Job runs a container to completion: the project's image, a command, an exit status, logs, and metered usage. It takes no HTTP handler and no worker. A Schedule may target it; every start is a JobRun.
Service Sylphx Workflows · Resource type workflows.sylphx.com/Job · Name pattern orgs/{org}/projects/{project}/envs/{env}/jobs/{job} · Shape spec_status
#Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/jobs/{job}. |
uid | string | job_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | JobSpec | Desired state. Required. |
status | JobStatus | Observed 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.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a job. |
GET | list | Lists jobs. |
POST | create | Creates a job. |
PATCH | update | Updates a job. Runs already started keep the generation they pinned. |
DELETE | delete | Deletes a job. |
#get
Gets a job.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/jobs/job · scope workflows:read · effect read · Request, response and examples
#list
Lists jobs.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/jobs · scope workflows:read · effect read · paginated · Request, response and examples
#create
Creates a job.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/jobs · scope workflows:write · effect write · long-running · Request, response and examples
#update
Updates a job. Runs already started keep the generation they pinned.
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/jobs/job · scope workflows:write · effect write · long-running · Request, response and examples
#delete
Deletes a job.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/jobs/job · scope workflows:write · effect destructive · long-running · Request, response and examples