Appearance

List Builds ​

Endpoint ​

http
GET /unified/ci-cd/builds
Integrations supported
  • Azure DevOps
  • CircleCI
  • GitHub
  • Jenkins
  • Travis CI
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • Jenkins

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 returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

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.
  • CircleCIThe project slug of the project on CircleCI. Its in the format vcs_provider/org_name/repo_name.
Required in
  • CircleCI
  • GitHub
  • Travis CI
workflow_id
string

The id of the workflow to filter the builds by.

Required in
  • Jenkins
workspace_id
string

The unique identifier for the workspace

Required in
  • Azure DevOps
started_at
string · date-time

The date and time when the build started

Supported in
  • Azure DevOps
completed_at
string · date-time

The date and time when the build finished

Supported in
  • Azure DevOps
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
status
string

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

Supported in
  • Azure DevOps

Response Body ​

result
object[]

List of Builds

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
triggered_by_type
string

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

Supported in
  • CircleCI
  • GitHub
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
  • GitHub
  • Jenkins
build
string

The build's unique identifier in the CI/CD

Supported in
  • GitHub
  • 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
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
  • GitHub
  • Jenkins
completed_at
string · date-time

The date and time when the build finished

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

The number of attempts for the build

Supported in
  • GitHub
  • Travis CI
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.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.