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
Get a job
Gets a job.
Gets a job.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/jobs/job - Scope
workflows:read - Effect
read— nothing is written. - Collection jobs
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the job to get. Required. |
#Response
| 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. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong 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_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#JobSpec
| Field | Type | What it is |
|---|---|---|
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. |
image | string | A digest-pinned image from this org's Artifacts, in place of the service's image. Exclusive with build. |
command | string[] | The entrypoint; empty keeps the image's. |
args | string[] | Arguments; a run may replace them. |
env | map<string, string> | Environment overrides on top of the service's env and Secret bindings. |
instance_type | string | A Hosting instance type; default standard. |
timeout | duration | One attempt's deadline, 10s to 24h; default 1h. |
max_retries | int32 | Re-runs after a non-zero exit, 0 to 10; backoff 30s doubling. |
concurrency | JobConcurrency | What a start does while a run is active; default forbid. One of forbid, queue, allow. |
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. |
#JobStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
resolved_image | string | The image digest the next run uses. Output only. |
last_run | string | The most recent run. Output only. |
#Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/jobs/job" \
-H "Authorization: Bearer $SYLPHX_API_KEY"