QLqlty
Builds

Get a build

Changed on

Retrieves details about a specific Build

get/gh/{ownerKeyOrId}/projects/{projectKeyOrId}/builds/{buildId}

Request

  • Base URL
    https://api.qlty.sh
  • Auth
    HTTP bearer

Path parameters

ownerKeyOrIdstring required

Repository owner name (login) or workspace ID

Example:acme-corp
projectKeyOrIdstring required

Repository name or project ID

Example:my-repo
buildIdstring required

Build ID

Example:550e8400-e29b-41d4-a716-446655440000

Response

Retrieve the build

idstring required
type'analysis' | 'format' | 'ssh' | 'coverage_setup' required
status'submitted' | 'starting' | 'running' | 'succeeded' | 'failed' | 'skipped' | 'rejected' required

Most recent status reported for the build

branchNamestring nullable required
commitShastring nullable required
commitMessagestring nullable required
submittedAtstring date-time required
finishedAtstring date-time nullable required
queueSecondsinteger nullable required
statusReasonstring nullable required

Explanation for the current status, when one was reported

conclusion'succeeded' | 'failed' nullable required

Terminal outcome, or null while the build is unfinished

exitCodeinteger nullable required
sourcestring nullable required
pullRequestNumberinteger nullable required
committerLoginstring nullable required
startedAtstring date-time nullable required
executionSecondsinteger nullable required

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "type": "analysis",
  "status": "succeeded",
  "branchName": "main",
  "commitSha": "9c9a4c4a1e6bb01b2fbd7f5e1c0b4a2d3e5f6a7b",
  "commitMessage": "Fix the bug",
  "submittedAt": "2026-01-01T12:00:00Z",
  "finishedAt": "2026-01-01T12:01:35Z",
  "queueSeconds": 5,
  "conclusion": "succeeded",
  "source": "github_push",
  "pullRequestNumber": 42,
  "committerLogin": "octocat",
  "startedAt": "2026-01-01T12:00:05Z",
  "executionSeconds": 90
}

Changes