Skip to content

Get Builds

Endpoint

http
GET /unified/ci-cd/builds/{id}
Integrations supported
  • Azure DevOps
  • CircleCI
  • GitHub
  • Jenkins
  • Travis CI

Path parameters

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
owner

The slug of the owner on Github.

Required in
  • GitHub
repo_id
Integration specific notes
  • GitHubThe slug of the repository on Github.
  • Travis CIThe ID of the repository.
Required in
  • GitHub
  • Travis CI
workflow_id
string

The id of the workflow to filter the builds by.

Supported in
  • Jenkins
workspace_id
string

The unique identifier for the workspace

Required in
  • Azure DevOps

Response Body

id
string
REQUIRED · 

The unique identifier for the build

Supported in
  • Azure DevOps
  • CircleCI
  • GitHub
  • Jenkins
  • Travis CI
name
string

The name of the build

Supported in
  • CircleCI
  • GitHub
  • Jenkins
  • Travis CI
repo
string

The repository of the build

Supported in
  • Azure DevOps
  • CircleCI
  • GitHub
  • Travis CI
branch
string

The head branch of the build

Supported in
  • Azure DevOps
  • CircleCI
  • GitHub
  • Travis CI
commit
string

The head commit of the build

Supported in
  • CircleCI
  • GitHub
  • Travis CI
trigger
string

The trigger for the build - push, merge_request, api, cron, web or the raw response from the API

Supported in
  • Azure DevOps
  • CircleCI
  • GitHub
  • Jenkins
  • Travis CI
triggered_by
string

The actor who triggered the build

Supported in
  • CircleCI
  • GitHub
  • Travis CI
triggered_by_type
string

The type of the actor who triggered the build - user, bot or raw response from the API

Supported in
  • GitHub
  • Travis CI
conclusion
string

The conclusion of the build - passed, failed, cancelled, timeout, skipped, retried, partial or the raw response from the API

Supported in
  • Azure DevOps
  • CircleCI
  • GitHub
  • Jenkins
  • Travis CI
workflow
string

The workflow's unique identifier in the CI/CD

Supported in
  • Jenkins
build
string

The build's unique identifier in the CI/CD

Supported in
  • Jenkins
status
string

The status of the build - queued, in_progress, completed or the raw response from the API

Supported in
  • Azure DevOps
  • CircleCI
  • GitHub
  • Jenkins
  • Travis CI
created_at
string · date-time

The date and time when the build was created

Supported in
  • CircleCI
  • GitHub
  • Travis CI
updated_at
string · date-time

The date and time when the build was last updated

Supported in
  • Azure DevOps
  • CircleCI
  • GitHub
  • Travis CI
started_at
string · date-time

The date and time when the build started

Supported in
  • Azure DevOps
  • CircleCI
  • GitHub
  • Jenkins
  • Travis CI
completed_at
string · date-time

The date and time when the build finished

Supported in
  • Azure DevOps
  • Jenkins
  • Travis CI
attempts
integer

The number of attempts for the build

Supported in
  • GitHub
number
integer

The run number of the build

Supported in
  • Azure DevOps
  • CircleCI
  • GitHub
  • Jenkins
  • Travis CI
remote_data
object

Raw data returned from the remote API call.