CIService

GetJob

Returns a job's identity, status, timestamps, runner configuration, parent run and workflow context, dependencies, and attempt history.

post/depot.ci.v1.CIService/GetJob

Request

  • Base URL
    https://api.depot.dev
  • Auth
    HTTP bearer

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

jobIdstring required

Unique identifier for the job. Returned by GetRunStatus and GetWorkflow.

Response

Success

orgIdstring

Depot organization that owns this job.

runIdstring

Unique identifier for the parent CI run.

repostring

GitHub repository in owner/name format. For example, "depot/cli".

refstring

Git ref the parent run was triggered against. Empty when the trigger carries no ref.

shastring

Commit SHA the parent run executes against. For pull_request triggers, the merge commit SHA.

headShastring

Source commit SHA for pull_request and merge_group triggers. Empty for triggers that don't carry a head SHA.

triggerstring

Event that triggered the parent run. For example, "push", "pull_request", "pull_request_target", "issue_comment", "merge_group", "schedule", "workflow_run", or "workflow_dispatch".

runStatusstring

Current state of the parent run. Can be "queued", "running", "finished", "failed", or "cancelled".

runCreatedAtstring

Parent run creation time, in RFC 3339 format.

runStartedAtstring

Parent run start time, in RFC 3339 format. Empty until the run starts.

runFinishedAtstring

Parent run finish time, in RFC 3339 format. Empty until the run finishes.

workflowIdstring

Unique identifier for the parent workflow.

workflowNamestring

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.

workflowPathstring

Parent workflow file path. For example, ".depot/workflows/ci.yml". Empty when the workflow YAML was passed via workflowContent in the Run request.

workflowStatusstring

Current state of the parent workflow. Can be "queued", "running", "finished", "failed", or "cancelled".

workflowErrorMessagestring

Parent workflow error or cancellation reason. For example, a compilation or validation error. Empty when the workflow is healthy.

workflowCreatedAtstring

Parent workflow creation time, in RFC 3339 format.

workflowStartedAtstring

Parent workflow start time, in RFC 3339 format. Empty until the workflow starts.

workflowFinishedAtstring

Parent workflow finish time, in RFC 3339 format. Empty until the workflow finishes.

jobIdstring

Unique identifier for the job.

jobKeystring

Job key from the workflow. For example, "build" or "test".

jobDisplayNamestring

Human-readable display name from the workflow. Falls back to jobKey when no display name is set.

jobStatusstring

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.

jobConclusionstring

Conclusion of the job. Can be "success", "failure", "cancelled", "skipped", or "timed_out". Empty until the job concludes.

jobErrorMessagestring

Job error message populated for orchestration or worker failures. Empty when the job has no error.

jobCreatedAtstring

Job creation time, in RFC 3339 format.

jobDispatchedAtstring

Job dispatch time, in RFC 3339 format. Empty until the job is dispatched to a worker.

jobStartedAtstring

Job start time, in RFC 3339 format. Empty until the job starts.

jobFinishedAtstring

Job finish time, in RFC 3339 format. Empty until the job finishes.

currentAttemptIdstring

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.

currentAttemptinteger

Most recent attempt number for this job. Zero until the first attempt is dispatched.

dependencyCountinteger nullable

Total number of dependencies. Set only when dependencies is a capped preview.

dependencyPreviewLimitinteger nullable

Maximum number of entries returned in dependencies. Set only when dependencies is a capped preview.

snapshotRefstring

Immutable snapshot image reference resolved for this job. Empty when the job is not a snapshot producer or the resolved ref is not available.

snapshotCachedboolean nullable

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.

waitingReasonstring

Reason a queued job is waiting. "timer" means it will become eligible at waitUntil. Empty otherwise.

waitUntilstring

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.