GetJob
Returns a job's identity, status, timestamps, runner configuration, parent run and workflow context, dependencies, and attempt history.
Request
- Base URLhttps://api.depot.dev
- AuthHTTP bearer
Headers
Define the version of the Connect protocol
Define the timeout, in ms
Request body
Unique identifier for the job. Returned by GetRunStatus and GetWorkflow.
Response
Success
Depot organization that owns this job.
Unique identifier for the parent CI run.
GitHub repository in owner/name format. For example, "depot/cli".
Git ref the parent run was triggered against. Empty when the trigger carries no ref.
Commit SHA the parent run executes against. For pull_request triggers, the merge commit SHA.
Source commit SHA for pull_request and merge_group triggers. Empty for triggers that don't carry a head SHA.
Event that triggered the parent run. For example, "push", "pull_request", "pull_request_target", "issue_comment", "merge_group", "schedule", "workflow_run", or "workflow_dispatch".
Current state of the parent run. Can be "queued", "running", "finished", "failed", or "cancelled".
Parent run creation time, in RFC 3339 format.
Parent run start time, in RFC 3339 format. Empty until the run starts.
Parent run finish time, in RFC 3339 format. Empty until the run finishes.
Unique identifier for the parent workflow.
Parent workflow name from the YAML name: key. Falls back to the file path stem when the workflow doesn't set name:. Empty when neither is available.
Parent workflow file path. For example, ".depot/workflows/ci.yml". Empty when the workflow YAML was passed via workflowContent in the Run request.
Current state of the parent workflow. Can be "queued", "running", "finished", "failed", or "cancelled".
Parent workflow error or cancellation reason. For example, a compilation or validation error. Empty when the workflow is healthy.
Parent workflow creation time, in RFC 3339 format.
Parent workflow start time, in RFC 3339 format. Empty until the workflow starts.
Parent workflow finish time, in RFC 3339 format. Empty until the workflow finishes.
Unique identifier for the job.
Job key from the workflow. For example, "build" or "test".
Human-readable display name from the workflow. Falls back to jobKey when no display name is set.
Current state of the job. Can be "queued", "waiting", "running", "finished", "failed", "cancelled", or "skipped". "waiting" means the job is blocked behind another run that holds the same concurrency: group slot.
Conclusion of the job. Can be "success", "failure", "cancelled", "skipped", or "timed_out". Empty until the job concludes.
Job error message populated for orchestration or worker failures. Empty when the job has no error.
Job creation time, in RFC 3339 format.
Job dispatch time, in RFC 3339 format. Empty until the job is dispatched to a worker.
Job start time, in RFC 3339 format. Empty until the job starts.
Job finish time, in RFC 3339 format. Empty until the job finishes.
Unique identifier for the most recent attempt for this job. Empty until the first attempt is dispatched, and cleared while a retried job waits for its next attempt to be dispatched.
Most recent attempt number for this job. Zero until the first attempt is dispatched.
Total number of dependencies. Set only when dependencies is a capped preview.
Maximum number of entries returned in dependencies. Set only when dependencies is a capped preview.
Immutable snapshot image reference resolved for this job. Empty when the job is not a snapshot producer or the resolved ref is not available.
True when the snapshot producer used an existing snapshot instead of running setup work. Unset when the job is not a snapshot producer or the resolved ref is not available.
Reason a queued job is waiting. "timer" means it will become eligible at waitUntil. Empty otherwise.
Time the job's configured delay ends, in RFC 3339 format. Empty when the job is not waiting on a timer.
Changes
No recorded changes to this operation across all 1 revision of this API.