API Developer Documentation

Builds

A list of builds.

If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.

Attributes

Name	Type	Description
builds	[Build]	List of builds.

Collection Items

Each entry in the builds array has the following attributes:

Name	Type	Description
id	Integer	Value uniquely identifying the build.
number	String	Incremental number for a repository's builds.
state	String	Current state of the build.
duration	Integer	Wall clock time in seconds.
event_type	String	Event that triggered the build.
previous_state	String	State of the previous build (useful to see if state changed).
pull_request_title	String	Title of the build's pull request.
pull_request_number	Integer	Number of the build's pull request.
started_at	String	When the build started.
finished_at	String	When the build finished.
private	Boolean	Whether or not the build is private.
priority	Unknown	The build's priority.
repository	Repository	GitHub user or organization the build belongs to.
branch	Branch	The branch the build is associated with.
tag	String	The build's tag.
commit	Commit	The commit the build is associated with.
jobs	Jobs	List of jobs that are part of the build's matrix.
stages	[Stage]	The stages of the build.
created_by	Owner	The User or Organization that created the build.
updated_at	String	The last time the build was updated.
request	Unknown	The build's request.
log_complete	Unknown	The build's log_complete.

Actions

For Current User

This returns a list of builds for the current user. The result is paginated. The default limit is 100.

GET

/builds

Query Parameter	Type	Description
include	[String]	List of attributes to eager load.
limit	Integer	How many builds to include in the response. Used for pagination.
limit	Integer	How many builds to include in the response. Used for pagination.
offset	Integer	How many builds to skip before the first entry in the response. Used for pagination.
offset	Integer	How many builds to skip before the first entry in the response. Used for pagination.
sort_by	[String]	Attributes to sort builds by. Used for pagination.
sort_by	[String]	Attributes to sort builds by. Used for pagination.

Example:GET /builds?limit=5

Sortable by: id, created_at, started_at, finished_at, number, append :desc to any attribute to reverse order.
The default value is number:desc,id:desc.

Find

This returns a list of builds for an individual repository. It is possible to use the repository id or slug in the request. The result is paginated. Each request will return 25 results.

GET

/repo/{provider}/{repository.id}/builds

Template Variable	Type	Description
provider	Unknown	Documentation missing.
repository.id	Integer	Value uniquely identifying the repository.

Query Parameter	Type	Description
branch.name	[String]	Filters builds by name of the git branch.
build.created_by	[Owner]	Filters builds by the User or Organization that created the build.
build.event_type	[String]	Filters builds by event that triggered the build.
build.previous_state	[String]	Filters builds by state of the previous build (useful to see if state changed).
build.state	[String]	Filters builds by current state of the build.
created_by	[Owner]	Alias for `build.created_by`.
event_type	[String]	Alias for `build.event_type`.
include	[String]	List of attributes to eager load.
limit	Integer	How many builds to include in the response. Used for pagination.
offset	Integer	How many builds to skip before the first entry in the response. Used for pagination.
previous_state	[String]	Alias for `build.previous_state`.
sort_by	[String]	Attributes to sort builds by. Used for pagination.
state	[String]	Alias for `build.state`.

Sortable by: id, created_at, started_at, finished_at, number, append :desc to any attribute to reverse order.
The default value is number:desc,id:desc.

GET

/repo/{provider}/{repository.slug}/builds

Template Variable	Type	Description
provider	Unknown	Documentation missing.
repository.slug	String	Same as {repository.owner.name}/{repository.name}.

Query Parameter	Type	Description
branch.name	[String]	Filters builds by name of the git branch.
build.created_by	[Owner]	Filters builds by the User or Organization that created the build.
build.event_type	[String]	Filters builds by event that triggered the build.
build.previous_state	[String]	Filters builds by state of the previous build (useful to see if state changed).
build.state	[String]	Filters builds by current state of the build.
created_by	[Owner]	Alias for `build.created_by`.
event_type	[String]	Alias for `build.event_type`.
include	[String]	List of attributes to eager load.
limit	Integer	How many builds to include in the response. Used for pagination.
offset	Integer	How many builds to skip before the first entry in the response. Used for pagination.
previous_state	[String]	Alias for `build.previous_state`.
sort_by	[String]	Attributes to sort builds by. Used for pagination.
state	[String]	Alias for `build.state`.

Sortable by: id, created_at, started_at, finished_at, number, append :desc to any attribute to reverse order.
The default value is number:desc,id:desc.

GET

/repo/{repository.id}/builds

Template Variable	Type	Description
repository.id	Integer	Value uniquely identifying the repository.

Query Parameter	Type	Description
branch.name	[String]	Filters builds by name of the git branch.
build.created_by	[Owner]	Filters builds by the User or Organization that created the build.
build.event_type	[String]	Filters builds by event that triggered the build.
build.previous_state	[String]	Filters builds by state of the previous build (useful to see if state changed).
build.state	[String]	Filters builds by current state of the build.
created_by	[Owner]	Alias for `build.created_by`.
event_type	[String]	Alias for `build.event_type`.
include	[String]	List of attributes to eager load.
limit	Integer	How many builds to include in the response. Used for pagination.
offset	Integer	How many builds to skip before the first entry in the response. Used for pagination.
previous_state	[String]	Alias for `build.previous_state`.
sort_by	[String]	Attributes to sort builds by. Used for pagination.
state	[String]	Alias for `build.state`.

Example:GET /repo/891/builds?limit=5

Sortable by: id, created_at, started_at, finished_at, number, append :desc to any attribute to reverse order.
The default value is number:desc,id:desc.

GET

/repo/{repository.slug}/builds

Template Variable	Type	Description
repository.slug	String	Same as {repository.owner.name}/{repository.name}.

Query Parameter	Type	Description
branch.name	[String]	Filters builds by name of the git branch.
build.created_by	[Owner]	Filters builds by the User or Organization that created the build.
build.event_type	[String]	Filters builds by event that triggered the build.
build.previous_state	[String]	Filters builds by state of the previous build (useful to see if state changed).
build.state	[String]	Filters builds by current state of the build.
created_by	[Owner]	Alias for `build.created_by`.
event_type	[String]	Alias for `build.event_type`.
include	[String]	List of attributes to eager load.
limit	Integer	How many builds to include in the response. Used for pagination.
offset	Integer	How many builds to skip before the first entry in the response. Used for pagination.
previous_state	[String]	Alias for `build.previous_state`.
sort_by	[String]	Attributes to sort builds by. Used for pagination.
state	[String]	Alias for `build.state`.

Example:GET /repo/rails%2Frails/builds?limit=5

Sortable by: id, created_at, started_at, finished_at, number, append :desc to any attribute to reverse order.
The default value is number:desc,id:desc.