Skip to content
Console
On this page

List jobs

Lists jobs.

Lists jobs.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/jobs
  • Scope workflows:read
  • Effect read — nothing is written.
  • Collection jobs
  • Query page_size, page_token, filter, order_by
  • Pagination the answer carries jobs and, when there is more, next_page_token

Request

FieldTypeWhat it is
parentstringThe parent to list in. Required.
page_sizeint32At most this many; default 50, clamped to 1000.
page_tokenstringnext_page_token of the previous page.
filterstringAIP-160 filter over labels and filterable fields.
order_bystringAIP-132 ordering over filterable fields.

Response

FieldTypeWhat it is
jobsJob[]The page.
next_page_tokenstringThe token of the next page; empty on the last page.

Job

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/jobs/{job}.
uidstringjob_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specJobSpecDesired state. Required.
statusJobStatusObserved state. Output only.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

JobSpec

FieldTypeWhat it is
servicestringThe 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.
imagestringA digest-pinned image from this org's Artifacts, in place of the service's image. Exclusive with build.
commandstring[]The entrypoint; empty keeps the image's.
argsstring[]Arguments; a run may replace them.
envmap<string, string>Environment overrides on top of the service's env and Secret bindings.
instance_typestringA Hosting instance type; default standard.
timeoutdurationOne attempt's deadline, 10s to 24h; default 1h.
max_retriesint32Re-runs after a non-zero exit, 0 to 10; backoff 30s doubling.
concurrencyJobConcurrencyWhat a start does while a run is active; default forbid. One of forbid, queue, allow.
buildstringA 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.

JobStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
resolved_imagestringThe image digest the next run uses. Output only.
last_runstringThe most recent run. Output only.

Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

Errors

Every error arrives in the body Errors describes.

Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/jobs" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"