CIService

GetRun

Returns a CI run's identity, repo, trigger, status, and timestamps. For nested workflow, job, and attempt status, use GetRunStatus.

post/depot.ci.v1.CIService/GetRun

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

runIdstring required

Unique identifier for the CI run. Returned by Run, DispatchWorkflow, and ListRuns.

Response

Success

orgIdstring

Depot organization that owns this run.

runIdstring

Unique identifier for the CI run.

repostring

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

refstring

Git ref the run was triggered against. For example, "refs/heads/main" or "refs/pull/42/merge". Empty when the trigger carries no ref.

shastring

Commit SHA the run executes against. Empty for open pull_request runs; populated with the merge commit SHA once the PR is closed and merged.

headShastring

Source commit SHA for pull_request and merge_group triggers; matches the PR or merge group head. Empty for triggers that don't carry a head SHA.

triggerstring

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

statusstring

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

createdAtstring

Creation time, in RFC 3339 format.

startedAtstring

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

finishedAtstring

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

Changes

No recorded changes to this operation across all 1 revision of this API.