---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Jobs"
description: "The `jobs` collection of Sylphx Workflows: A Job runs a container to completion: the project's image, a command, an exit status, logs, and metered usage."
type: reference
product: jobs
summary: "A Job runs a container to completion: the project's image, a command, an exit status, logs, and metered usage."
updated: 2026-09-28
order: 900
---

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`](/docs/api/jobs#get) | Gets a job. |
| `GET` | [`list`](/docs/api/jobs#list) | Lists jobs. |
| `POST` | [`create`](/docs/api/jobs#create) | Creates a job. |
| `PATCH` | [`update`](/docs/api/jobs#update) | Updates a job. Runs already started keep the generation they pinned. |
| `DELETE` | [`delete`](/docs/api/jobs#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](/docs/api/jobs/get)

## 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](/docs/api/jobs/list)

## 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](/docs/api/jobs/create)

## 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](/docs/api/jobs/update)

## 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](/docs/api/jobs/delete)