Buildkite

Buildkite integration (Developer Tools). Imported from open-connector.

API key12 toolshttps://api.buildkite.com/v2

GET

buildkite_get_current_access_token

Inspect the current Buildkite API access token, including scopes and owner summary.

/access-token

GET

buildkite_get_current_user

Get the Buildkite user account that owns the current API access token.

/user

GET

buildkite_list_organizations

List Buildkite organizations accessible to the current API token.

/organizations

2 parameters

Param	Type	Required	Description
page	integer	optional	The page of results to return.
per_page	integer	optional	How many results to return per page.

GET

buildkite_get_organization

Get a single Buildkite organization by slug.

/organizations/{org_slug}

1 parameter

Param	Type	Required	Description
org_slug	string	required	The Buildkite organization slug.

GET

buildkite_list_pipelines

List Buildkite pipelines for an organization.

/organizations/{org_slug}/pipelines

5 parameters

Param	Type	Required	Description
org_slug	string	required	The Buildkite organization slug.
page	integer	optional	The page of results to return.
per_page	integer	optional	How many results to return per page.
name	string	optional	Only return pipelines whose name contains this case-insensitive value.
repository	string	optional	Only return pipelines whose repository URL contains this case-insensitive value.

GET

buildkite_get_pipeline

Get a single Buildkite pipeline by organization and pipeline slug.

/organizations/{org_slug}/pipelines/{pipeline_slug}

2 parameters

Param	Type	Required	Description
org_slug	string	required	The Buildkite organization slug.
pipeline_slug	string	required	The Buildkite pipeline slug.

GET

buildkite_list_builds_for_organization

List builds across all pipelines in a Buildkite organization.

/organizations/{org_slug}/builds

10 parameters

Param	Type	Required	Description
org_slug	string	required	The Buildkite organization slug.
page	integer	optional	The page of results to return.
per_page	integer	optional	How many results to return per page.
branch	string	optional	Only return builds for this branch.
commit	string	optional	Only return builds for this full commit SHA.
created_from	string	optional	Only return builds created on or after this ISO 8601 timestamp.
created_to	string	optional	Only return builds created before this ISO 8601 timestamp.
finished_from	string	optional	Only return builds finished on or after this ISO 8601 timestamp.
state	string	optional	Only return builds in this Buildkite state.
include_retried_jobs	boolean	optional	Whether retried job executions should be included in each build.

GET

buildkite_list_builds_for_pipeline

List builds for a single Buildkite pipeline.

/organizations/{org_slug}/pipelines/{pipeline_slug}/builds

11 parameters

Param	Type	Required	Description
org_slug	string	required	The Buildkite organization slug.
pipeline_slug	string	required	The Buildkite pipeline slug.
page	integer	optional	The page of results to return.
per_page	integer	optional	How many results to return per page.
branch	string	optional	Only return builds for this branch.
commit	string	optional	Only return builds for this full commit SHA.
created_from	string	optional	Only return builds created on or after this ISO 8601 timestamp.
created_to	string	optional	Only return builds created before this ISO 8601 timestamp.
finished_from	string	optional	Only return builds finished on or after this ISO 8601 timestamp.
state	string	optional	Only return builds in this Buildkite state.
include_retried_jobs	boolean	optional	Whether retried job executions should be included in each build.

GET

buildkite_get_build

Get a single Buildkite build by organization, pipeline slug, and build number.

/organizations/{org_slug}/pipelines/{pipeline_slug}/builds/{number}

5 parameters

Param	Type	Required	Description
org_slug	string	required	The Buildkite organization slug.
pipeline_slug	string	required	The Buildkite pipeline slug.
number	integer	required	The pipeline-local Buildkite build number.
include_retried_jobs	boolean	optional	Whether retried job executions should be included in each build.
include_test_engine	boolean	optional	Whether Buildkite Test Engine data should be included in the build response.

POST

buildkite_create_build

Create a new Buildkite build for a pipeline.

/organizations/{org_slug}/pipelines/{pipeline_slug}/builds

14 parameters

Param	Type	Required	Description
org_slug	string	required	The Buildkite organization slug.
pipeline_slug	string	required	The Buildkite pipeline slug.
commit	string	required	The ref, SHA, or tag to build.
branch	string	required	The branch the build commit belongs to.
message	string	optional	Custom message for the build, when provided.
author	object	optional	Build author metadata.
env	object	optional	A JSON object whose values are strings.
meta_data	object	optional	Metadata values to attach to the build.
clean_checkout	boolean	optional	Whether the agent should perform a fresh checkout.
ignore_pipeline_branch_filters	boolean	optional	Whether the build should ignore pipeline-level branch filters.
pull_request_id	integer	optional	Pull request number for a pull request build.
pull_request_base_branch	string	optional	Base branch for a pull request build.
pull_request_repository	string	optional	Repository URL of the pull request build source.
pull_request_labels	array	optional	A non-empty list of strings.

PUT

buildkite_cancel_build

Cancel a Buildkite build by build number.

/organizations/{org_slug}/pipelines/{pipeline_slug}/builds/{number}/cancel

3 parameters

Param	Type	Required	Description
org_slug	string	required	The Buildkite organization slug.
pipeline_slug	string	required	The Buildkite pipeline slug.
number	integer	required	The pipeline-local Buildkite build number.

PUT

buildkite_rebuild_build

Rebuild a Buildkite build by build number.

/organizations/{org_slug}/pipelines/{pipeline_slug}/builds/{number}/rebuild

3 parameters

Param	Type	Required	Description
org_slug	string	required	The Buildkite organization slug.
pipeline_slug	string	required	The Buildkite pipeline slug.
number	integer	required	The pipeline-local Buildkite build number.