Buildkite Agent API

Backplane consumed by the Buildkite Agent (open source, Go) to register, deregister, accept and finish jobs, upload artifacts, stream job logs, and emit metrics for cluster autoscaling. Authenticated via Agent Tokens issued per cluster. Public surface includes `/metrics` (for autoscaling) and `/stacks` (for self-hosted queue controllers). The `agent-edge.buildkite.com` host adds gRPC methods. Most other endpoints are reserved for internal agent use.

API entry from apis.yml

apis.yml Raw ↑
aid: buildkite-com:buildkite-agent-api
name: Buildkite Agent API
tags:
- CI/CD
- Agents
- Hybrid CI
humanURL: https://buildkite.com/docs/apis/agent-api
baseURL: https://agent.buildkite.com/v3
properties:
- url: https://buildkite.com/docs/apis/agent-api
  type: Documentation
- url: https://buildkite.com/docs/agent/v3
  type: Documentation
- url: https://github.com/buildkite/agent
  type: SourceCode
description: Backplane consumed by the Buildkite Agent (open source, Go) to register, deregister, accept
  and finish jobs, upload artifacts, stream job logs, and emit metrics for cluster autoscaling. Authenticated
  via Agent Tokens issued per cluster. Public surface includes `/metrics` (for autoscaling) and `/stacks`
  (for self-hosted queue controllers). The `agent-edge.buildkite.com` host adds gRPC methods. Most other
  endpoints are reserved for internal agent use.