Buildkite
Buildkite is a CI/CD platform with self-hosted agents and a hosted control plane. The platform exposes a REST API, a GraphQL API and an Agent API used by buildkite-agent. Resources include organizations, pipelines, pipeline templates, builds, jobs, agents, clusters, queues, teams, rules, artifacts, annotations, and access tokens. Test Engine adds test execution and analytics endpoints.
APIs
Buildkite REST API
JSON over HTTPS REST API for the Buildkite control plane. Bearer-token auth with API access tokens.
Buildkite GraphQL API
Relay-compliant GraphQL API. Single endpoint for nested queries across organizations, pipelines, builds, jobs, agents, teams. Introspection supported. Bearer auth with the "Enab...
Buildkite Agent API
API consumed by buildkite-agent — register, retrieve work, send job events and upload artifacts/annotations. Used by self-hosted and hosted agents.
Collections
Buildkite REST API
OPENGraphQL
Buildkite GraphQL API
Relay-compliant GraphQL API. Single endpoint for nested queries across organizations, pipelines, builds, jobs, agents, teams. Introspection supported. Bearer auth with the "Enab...
GRAPHQLPricing Plans
Rate Limits
FinOps
Buildkite Finops
FINOPSResources
Sources
opencollection: 1.0.0
info:
name: Buildkite REST API
version: '2.0'
request:
auth:
type: bearer
token: '{{bearerToken}}'
items:
- info:
name: Organizations
type: folder
items:
- info:
name: List organizations
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations
docs: List organizations
- info:
name: Get an organization
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org
params:
- name: org
value: ''
type: path
description: Organization slug.
docs: Get an organization
- info:
name: List members
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/members
params:
- name: org
value: ''
type: path
description: Organization slug.
docs: List members
- info:
name: Get a member
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/members/:userUuid
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: userUuid
value: ''
type: path
docs: Get a member
- info:
name: Pipelines
type: folder
items:
- info:
name: List pipelines
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/pipelines
params:
- name: org
value: ''
type: path
description: Organization slug.
docs: List pipelines
- info:
name: Create pipeline
type: http
http:
method: POST
url: https://api.buildkite.com/v2/organizations/:org/pipelines
params:
- name: org
value: ''
type: path
description: Organization slug.
body:
type: json
data: '{}'
docs: Create pipeline
- info:
name: Get pipeline
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
docs: Get pipeline
- info:
name: Update pipeline
type: http
http:
method: PATCH
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
body:
type: json
data: '{}'
docs: Update pipeline
- info:
name: Delete pipeline
type: http
http:
method: DELETE
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
docs: Delete pipeline
- info:
name: Archive pipeline
type: http
http:
method: POST
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/archive
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
docs: Archive pipeline
- info:
name: Unarchive pipeline
type: http
http:
method: POST
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/unarchive
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
docs: Unarchive pipeline
- info:
name: Rotate webhook URL
type: http
http:
method: POST
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/webhook
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
docs: Rotate webhook URL
- info:
name: Builds
type: folder
items:
- info:
name: List all builds
type: http
http:
method: GET
url: https://api.buildkite.com/v2/builds
docs: List all builds
- info:
name: List org builds
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/builds
params:
- name: org
value: ''
type: path
description: Organization slug.
docs: List org builds
- info:
name: List pipeline builds
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
docs: List pipeline builds
- info:
name: Create build
type: http
http:
method: POST
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
body:
type: json
data: '{}'
docs: Create build
- info:
name: Get build
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds/:number
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
- name: number
value: ''
type: path
description: Build number.
docs: Get build
- info:
name: Cancel build
type: http
http:
method: PUT
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds/:number/cancel
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
- name: number
value: ''
type: path
description: Build number.
docs: Cancel build
- info:
name: Rebuild
type: http
http:
method: PUT
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds/:number/rebuild
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
- name: number
value: ''
type: path
description: Build number.
docs: Rebuild
- info:
name: Jobs
type: folder
items:
- info:
name: Retry a job
type: http
http:
method: PUT
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds/:number/jobs/:jobId/retry
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
- name: number
value: ''
type: path
description: Build number.
- name: jobId
value: ''
type: path
description: Job ID.
docs: Retry a job
- info:
name: Reprioritize a job
type: http
http:
method: PUT
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds/:number/jobs/:jobId/reprioritize
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
- name: number
value: ''
type: path
description: Build number.
- name: jobId
value: ''
type: path
description: Job ID.
body:
type: json
data: '{}'
docs: Reprioritize a job
- info:
name: Unblock a job
type: http
http:
method: PUT
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds/:number/jobs/:jobId/unblock
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
- name: number
value: ''
type: path
description: Build number.
- name: jobId
value: ''
type: path
description: Job ID.
body:
type: json
data: '{}'
docs: Unblock a job
- info:
name: Get job log
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds/:number/jobs/:jobId/log
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
- name: number
value: ''
type: path
description: Build number.
- name: jobId
value: ''
type: path
description: Job ID.
docs: Get job log
- info:
name: Delete job log
type: http
http:
method: DELETE
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds/:number/jobs/:jobId/log
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
- name: number
value: ''
type: path
description: Build number.
- name: jobId
value: ''
type: path
description: Job ID.
docs: Delete job log
- info:
name: Get job environment variables
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds/:number/jobs/:jobId/env
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
- name: number
value: ''
type: path
description: Build number.
- name: jobId
value: ''
type: path
description: Job ID.
docs: Get job environment variables
- info:
name: Annotations
type: folder
items:
- info:
name: List annotations
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds/:number/annotations
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
- name: number
value: ''
type: path
description: Build number.
docs: List annotations
- info:
name: Create annotation
type: http
http:
method: POST
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds/:number/annotations
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
- name: number
value: ''
type: path
description: Build number.
body:
type: json
data: '{}'
docs: Create annotation
- info:
name: Delete annotation
type: http
http:
method: DELETE
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds/:number/annotations/:uuid
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
- name: number
value: ''
type: path
description: Build number.
- name: uuid
value: ''
type: path
docs: Delete annotation
- info:
name: Artifacts
type: folder
items:
- info:
name: List build artifacts
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds/:number/artifacts
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
- name: number
value: ''
type: path
description: Build number.
docs: List build artifacts
- info:
name: List job artifacts
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds/:number/jobs/:jobId/artifacts
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
- name: number
value: ''
type: path
description: Build number.
- name: jobId
value: ''
type: path
description: Job ID.
docs: List job artifacts
- info:
name: Get artifact
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds/:number/jobs/:jobId/artifacts/:id
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
- name: number
value: ''
type: path
description: Build number.
- name: jobId
value: ''
type: path
description: Job ID.
- name: id
value: ''
type: path
docs: Get artifact
- info:
name: Delete artifact
type: http
http:
method: DELETE
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds/:number/jobs/:jobId/artifacts/:id
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
- name: number
value: ''
type: path
description: Build number.
- name: jobId
value: ''
type: path
description: Job ID.
- name: id
value: ''
type: path
docs: Delete artifact
- info:
name: Download artifact
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/pipelines/:slug/builds/:number/jobs/:jobId/artifacts/:id/download
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: slug
value: ''
type: path
description: Pipeline slug.
- name: number
value: ''
type: path
description: Build number.
- name: jobId
value: ''
type: path
description: Job ID.
- name: id
value: ''
type: path
docs: Download artifact
- info:
name: Agents
type: folder
items:
- info:
name: List agents
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/agents
params:
- name: org
value: ''
type: path
description: Organization slug.
docs: List agents
- info:
name: Get agent
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/agents/:id
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: id
value: ''
type: path
docs: Get agent
- info:
name: Stop agent
type: http
http:
method: PUT
url: https://api.buildkite.com/v2/organizations/:org/agents/:id/stop
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: id
value: ''
type: path
docs: Stop agent
- info:
name: Pause agent
type: http
http:
method: PUT
url: https://api.buildkite.com/v2/organizations/:org/agents/:id/pause
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: id
value: ''
type: path
docs: Pause agent
- info:
name: Resume agent
type: http
http:
method: PUT
url: https://api.buildkite.com/v2/organizations/:org/agents/:id/resume
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: id
value: ''
type: path
docs: Resume agent
- info:
name: Teams
type: folder
items:
- info:
name: List teams
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/teams
params:
- name: org
value: ''
type: path
description: Organization slug.
docs: List teams
- info:
name: Create team
type: http
http:
method: POST
url: https://api.buildkite.com/v2/organizations/:org/teams
params:
- name: org
value: ''
type: path
description: Organization slug.
body:
type: json
data: '{}'
docs: Create team
- info:
name: Get team
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/teams/:teamUuid
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: teamUuid
value: ''
type: path
docs: Get team
- info:
name: Update team
type: http
http:
method: PATCH
url: https://api.buildkite.com/v2/organizations/:org/teams/:teamUuid
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: teamUuid
value: ''
type: path
body:
type: json
data: '{}'
docs: Update team
- info:
name: Delete team
type: http
http:
method: DELETE
url: https://api.buildkite.com/v2/organizations/:org/teams/:teamUuid
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: teamUuid
value: ''
type: path
docs: Delete team
- info:
name: Clusters
type: folder
items:
- info:
name: List clusters
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/clusters
params:
- name: org
value: ''
type: path
description: Organization slug.
docs: List clusters
- info:
name: Create cluster
type: http
http:
method: POST
url: https://api.buildkite.com/v2/organizations/:org/clusters
params:
- name: org
value: ''
type: path
description: Organization slug.
body:
type: json
data: '{}'
docs: Create cluster
- info:
name: Get cluster
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/clusters/:id
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: id
value: ''
type: path
docs: Get cluster
- info:
name: Update cluster
type: http
http:
method: PUT
url: https://api.buildkite.com/v2/organizations/:org/clusters/:id
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: id
value: ''
type: path
body:
type: json
data: '{}'
docs: Update cluster
- info:
name: Delete cluster
type: http
http:
method: DELETE
url: https://api.buildkite.com/v2/organizations/:org/clusters/:id
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: id
value: ''
type: path
docs: Delete cluster
- info:
name: Queues
type: folder
items:
- info:
name: List queues
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/clusters/:clusterId/queues
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: clusterId
value: ''
type: path
description: Cluster ID.
docs: List queues
- info:
name: Create queue
type: http
http:
method: POST
url: https://api.buildkite.com/v2/organizations/:org/clusters/:clusterId/queues
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: clusterId
value: ''
type: path
description: Cluster ID.
body:
type: json
data: '{}'
docs: Create queue
- info:
name: Get queue
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/clusters/:clusterId/queues/:id
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: clusterId
value: ''
type: path
description: Cluster ID.
- name: id
value: ''
type: path
docs: Get queue
- info:
name: Update queue
type: http
http:
method: PUT
url: https://api.buildkite.com/v2/organizations/:org/clusters/:clusterId/queues/:id
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: clusterId
value: ''
type: path
description: Cluster ID.
- name: id
value: ''
type: path
body:
type: json
data: '{}'
docs: Update queue
- info:
name: Delete queue
type: http
http:
method: DELETE
url: https://api.buildkite.com/v2/organizations/:org/clusters/:clusterId/queues/:id
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: clusterId
value: ''
type: path
description: Cluster ID.
- name: id
value: ''
type: path
docs: Delete queue
- info:
name: Pause dispatch
type: http
http:
method: POST
url: https://api.buildkite.com/v2/organizations/:org/clusters/:clusterId/queues/:id/pause_dispatch
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: clusterId
value: ''
type: path
description: Cluster ID.
- name: id
value: ''
type: path
docs: Pause dispatch
- info:
name: Resume dispatch
type: http
http:
method: POST
url: https://api.buildkite.com/v2/organizations/:org/clusters/:clusterId/queues/:id/resume_dispatch
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: clusterId
value: ''
type: path
description: Cluster ID.
- name: id
value: ''
type: path
docs: Resume dispatch
- info:
name: AgentTokens
type: folder
items:
- info:
name: List agent tokens
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/clusters/:clusterId/tokens
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: clusterId
value: ''
type: path
description: Cluster ID.
docs: List agent tokens
- info:
name: Create agent token
type: http
http:
method: POST
url: https://api.buildkite.com/v2/organizations/:org/clusters/:clusterId/tokens
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: clusterId
value: ''
type: path
description: Cluster ID.
body:
type: json
data: '{}'
docs: Create agent token
- info:
name: Get agent token
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/clusters/:clusterId/tokens/:id
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: clusterId
value: ''
type: path
description: Cluster ID.
- name: id
value: ''
type: path
docs: Get agent token
- info:
name: Update agent token
type: http
http:
method: PUT
url: https://api.buildkite.com/v2/organizations/:org/clusters/:clusterId/tokens/:id
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: clusterId
value: ''
type: path
description: Cluster ID.
- name: id
value: ''
type: path
body:
type: json
data: '{}'
docs: Update agent token
- info:
name: Revoke agent token
type: http
http:
method: DELETE
url: https://api.buildkite.com/v2/organizations/:org/clusters/:clusterId/tokens/:id
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: clusterId
value: ''
type: path
description: Cluster ID.
- name: id
value: ''
type: path
docs: Revoke agent token
- info:
name: PipelineTemplates
type: folder
items:
- info:
name: List pipeline templates
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/pipeline-templates
params:
- name: org
value: ''
type: path
description: Organization slug.
docs: List pipeline templates
- info:
name: Create pipeline template
type: http
http:
method: POST
url: https://api.buildkite.com/v2/organizations/:org/pipeline-templates
params:
- name: org
value: ''
type: path
description: Organization slug.
body:
type: json
data: '{}'
docs: Create pipeline template
- info:
name: Get pipeline template
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/pipeline-templates/:uuid
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: uuid
value: ''
type: path
docs: Get pipeline template
- info:
name: Update pipeline template
type: http
http:
method: PATCH
url: https://api.buildkite.com/v2/organizations/:org/pipeline-templates/:uuid
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: uuid
value: ''
type: path
body:
type: json
data: '{}'
docs: Update pipeline template
- info:
name: Delete pipeline template
type: http
http:
method: DELETE
url: https://api.buildkite.com/v2/organizations/:org/pipeline-templates/:uuid
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: uuid
value: ''
type: path
docs: Delete pipeline template
- info:
name: Rules
type: folder
items:
- info:
name: List rules
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/rules
params:
- name: org
value: ''
type: path
description: Organization slug.
docs: List rules
- info:
name: Create rule
type: http
http:
method: POST
url: https://api.buildkite.com/v2/organizations/:org/rules
params:
- name: org
value: ''
type: path
description: Organization slug.
body:
type: json
data: '{}'
docs: Create rule
- info:
name: Get rule
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/rules/:uuid
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: uuid
value: ''
type: path
docs: Get rule
- info:
name: Delete rule
type: http
http:
method: DELETE
url: https://api.buildkite.com/v2/organizations/:org/rules/:uuid
params:
- name: org
value: ''
type: path
description: Organization slug.
- name: uuid
value: ''
type: path
docs: Delete rule
- info:
name: Emojis
type: folder
items:
- info:
name: List custom emojis
type: http
http:
method: GET
url: https://api.buildkite.com/v2/organizations/:org/emojis
params:
- name: org
value: ''
type: path
description: Organization slug.
docs: List custom emojis
- info:
name: User
type: folder
items:
- info:
name: Get current user
type: http
http:
method: GET
url: https://api.buildkite.com/v2/user
docs: Get current user
- info:
name: AccessToken
type: folder
items:
- info:
name: Get current access token
type: http
http:
method: GET
url: https://api.buildkite.com/v2/access-token
docs: Get current access token
- info:
name: Revoke current access token
type: http
http:
method: DELETE
url: https://api.buildkite.com/v2/access-token
docs: Revoke current access token
- info:
name: Meta
type: folder
items:
- info:
name: Get Buildkite meta information
type: http
http:
method: GET
url: https://api.buildkite.com/v2/meta
docs: Get Buildkite meta information
bundled: true