Buildkite

Buildkite Agents API

The Agents API from Buildkite — 3 operation(s) for agents.

GitHub OpenAPI

Operations 3

GET /organizations/{org}/agents List Agents #
GET /organizations/{org}/agents/{id} Get An Agent #
PUT /organizations/{org}/agents/{id}/stop Stop An Agent #

Documentation

📖
Documentation
https://buildkite.com/docs/apis/rest-api
📖
Authentication
https://buildkite.com/docs/apis/managing-api-tokens

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/buildkite-com/refs/heads/main/openapi/buildkite-com-agents-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/buildkite-com/refs/heads/main/json-schema/buildkite-pipeline-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/buildkite-com/refs/heads/main/json-schema/buildkite-build-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/buildkite-com/refs/heads/main/json-schema/buildkite-agent-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/buildkite-com/refs/heads/main/json-ld/buildkite-com-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/buildkite-com-agents-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

buildkite-com-agents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Buildkite REST Agents API
  version: v2
  description: 'Programmatic control of Buildkite Pipelines covering organizations, pipelines,

    builds, jobs, artifacts, annotations, agents, clusters, queues, and access tokens.

    Authenticated with a Bearer API access token.

    '
  contact:
    name: Buildkite Support
    url: https://buildkite.com/support
  license:
    name: Buildkite Terms of Service
    url: https://buildkite.com/legal/terms-of-service
servers:
- url: https://api.buildkite.com/v2
  description: Buildkite REST API v2
security:
- bearerAuth: []
tags:
- name: Agents
paths:
  /organizations/{org}/agents:
    get:
      tags:
      - Agents
      summary: List Agents
      operationId: listAgents
      parameters:
      - $ref: '#/components/parameters/Org'
      responses:
        '200':
          description: A list of agents
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Agent'
  /organizations/{org}/agents/{id}:
    get:
      tags:
      - Agents
      summary: Get An Agent
      operationId: getAgent
      parameters:
      - $ref: '#/components/parameters/Org'
      - $ref: '#/components/parameters/AgentId'
      responses:
        '200':
          description: Agent record
  /organizations/{org}/agents/{id}/stop:
    put:
      tags:
      - Agents
      summary: Stop An Agent
      operationId: stopAgent
      parameters:
      - $ref: '#/components/parameters/Org'
      - $ref: '#/components/parameters/AgentId'
      responses:
        '204':
          description: Agent stopped
components:
  schemas:
    Agent:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        connection_state:
          type: string
          enum:
          - connected
          - disconnected
          - stopped
          - stopping
          - lost
          - never_connected
        hostname:
          type: string
        ip_address:
          type: string
        user_agent:
          type: string
        version:
          type: string
        meta_data:
          type: array
          items:
            type: string
        cluster_id:
          type: string
          format: uuid
        queue:
          type: string
        created_at:
          type: string
          format: date-time
  parameters:
    AgentId:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: Agent UUID
    Org:
      name: org
      in: path
      required: true
      schema:
        type: string
      description: Organization slug
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API access token