Buildkite

Buildkite Metrics API

The Metrics API from Buildkite — 1 operation(s) for metrics.

GitHub OpenAPI

Operations 1

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /metrics Get agent and job counts for a cluster · Get Cluster Agent Metrics #
Ask an LLM
“How many jobs are waiting and how many agents are idle in my cluster?”
“Can an autoscaler read current agent and job counts using an agent token?”
Tell an agent
Get the current agent and job metrics for my cluster.
Check queued job counts so I can size the agent pool.

Documentation

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

Specifications

⚙
OpenAPI
https://artifacts.apis.io/buildkite-com/openapi/buildkite-com-metrics-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/buildkite-com/json-schema/buildkite-pipeline-schema.json
📊
JSONSchema
https://artifacts.apis.io/buildkite-com/json-schema/buildkite-build-schema.json
📊
JSONSchema
https://artifacts.apis.io/buildkite-com/json-schema/buildkite-agent-schema.json

Other Resources

🔗
JSONLD
https://artifacts.apis.io/buildkite-com/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:buildkite-com-metrics-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-metrics-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Buildkite Agent Metrics API
  version: v3
  description: 'Public subset of the Buildkite Agent API consumed by the open-source agent (Go) to register,

    accept, and finish jobs. Most endpoints are reserved for internal use; only the documented

    public endpoints are stable. Authenticated with an Agent Token (`Authorization: Token `).'
  contact:
    name: Buildkite Agent
    url: https://github.com/buildkite/agent
servers:
- url: https://agent.buildkite.com/v3
  description: Standard Agent API
- url: https://agent-edge.buildkite.com/v3
  description: Edge Agent API (adds gRPC methods alongside JSON)
security:
- agentToken: []
tags:
- name: Metrics
paths:
  /metrics:
    get:
      tags:
      - Metrics
      summary: Get Cluster Agent Metrics
      operationId: getMetrics
      description: Returns current agent and job counts for the cluster associated with the agent token. Used by autoscalers (Lambda scaler, agent-stack-k8s, custom controllers) to size agent pools.
      responses:
        '200':
          description: Cluster metrics payload
          content:
            application/json:
              schema:
                type: object
                properties:
                  agents:
                    type: object
                    properties:
                      idle:
                        type: integer
                      busy:
                        type: integer
                      total:
                        type: integer
                  jobs:
                    type: object
                    properties:
                      scheduled:
                        type: integer
                      running:
                        type: integer
                      total:
                        type: integer
                  organization:
                    type: object
                    properties:
                      slug:
                        type: string
components:
  securitySchemes:
    agentToken:
      type: http
      scheme: bearer
      bearerFormat: Agent Token (sent as `Token <value>`)