# Buildkite APIs Documentation > Buildkite documentation for APIs, covering the REST API, GraphQL API, webhooks, MCP server, agent API, model providers, API token management, portals, and rate limits. ## APIs - [Overview](https://buildkite.com/docs/apis.md): Overview of Buildkite APIs: REST, GraphQL, webhooks, MCP server, agent API, and authentication. - [Managing API access tokens](https://buildkite.com/docs/apis/managing-api-tokens.md): Creating, editing, auditing, and securing API access tokens with scopes and IP restrictions. - [API differences](https://buildkite.com/docs/apis/api-differences.md): Feature comparison between REST and GraphQL APIs, listing capabilities unique to each. ### REST - [Overview](https://buildkite.com/docs/apis/rest-api.md): REST API overview: schema, authentication, pagination, endpoints, and response conventions. - [Rate limits](https://buildkite.com/docs/apis/rest-api/rate-limits.md) - [Access token](https://buildkite.com/docs/apis/rest-api/access-token.md): REST endpoints to inspect and revoke the current API access token. - [Emojis](https://buildkite.com/docs/apis/rest-api/emojis.md): REST endpoint to list all emojis (including custom) for an organization. - [Meta](https://buildkite.com/docs/apis/rest-api/meta.md): REST endpoint returning Buildkite metadata including webhook IP addresses (no auth required). - [User](https://buildkite.com/docs/apis/rest-api/user.md): REST endpoint to get details about the authenticated user account. #### Organizations - [Overview](https://buildkite.com/docs/apis/rest-api/organizations.md): REST endpoints to list and retrieve Buildkite organization details. - [Members](https://buildkite.com/docs/apis/rest-api/organizations/members.md): REST endpoint to list all members of a Buildkite organization. - [Rate limits](https://buildkite.com/docs/apis/rest-api/organizations/rate-limits.md): REST endpoint to query an organization's current REST and GraphQL API rate limit status. #### Package Registries - [Registries](https://buildkite.com/docs/apis/rest-api/package-registries/registries.md): REST endpoints to create, list, get, update, and delete package registries. - [Registry tokens](https://buildkite.com/docs/apis/rest-api/package-registries/registry-tokens.md): REST endpoints to create and manage registry tokens for package installation. - [Packages](https://buildkite.com/docs/apis/rest-api/package-registries/packages.md): REST endpoints to publish, list, get, and delete packages in a registry. #### Pipelines - [Overview](https://buildkite.com/docs/apis/rest-api/pipelines.md): REST endpoints to create, list, get, update, archive, and delete pipelines. - [Agents](https://buildkite.com/docs/apis/rest-api/agents.md): REST endpoints to list, get, stop, pause, and resume agents. - [Annotations](https://buildkite.com/docs/apis/rest-api/annotations.md): REST endpoints to list and create Markdown annotations on builds. - [Artifacts](https://buildkite.com/docs/apis/rest-api/artifacts.md): REST endpoints to list and download build artifacts by build or job. - [Builds](https://buildkite.com/docs/apis/rest-api/builds.md): REST endpoints to list, get, create, cancel, and rebuild builds with filtering options. ##### Clusters - [Overview](https://buildkite.com/docs/apis/rest-api/clusters.md): REST endpoints to create, list, get, update, and delete clusters. - [Queues](https://buildkite.com/docs/apis/rest-api/clusters/queues.md): REST endpoints to create, list, get, update, pause, resume, and delete cluster queues. - [Agent tokens](https://buildkite.com/docs/apis/rest-api/clusters/agent-tokens.md): REST endpoints to create, list, get, update, and revoke cluster agent tokens. - [Cluster maintainers](https://buildkite.com/docs/apis/rest-api/clusters/maintainers.md): REST endpoints to list, create, get, and delete cluster maintainer assignments. - [Buildkite secrets](https://buildkite.com/docs/apis/rest-api/clusters/secrets.md): REST endpoints to create, list, get, update, and delete secrets in a cluster. - [Jobs](https://buildkite.com/docs/apis/rest-api/jobs.md): REST endpoints to retry, unblock, get log output, get environment variables, and delete jobs. - [Pipeline templates](https://buildkite.com/docs/apis/rest-api/pipeline-templates.md): REST endpoints to create and manage pipeline templates (Enterprise plan). - [Rules](https://buildkite.com/docs/apis/rest-api/rules.md): REST endpoints to create, list, get, and delete organization rules. - [Schedules](https://buildkite.com/docs/apis/rest-api/pipeline-schedules.md): REST endpoints to list, get, create, update, and delete pipeline schedules that automatically trigger builds at specified intervals. #### Teams - [Overview](https://buildkite.com/docs/apis/rest-api/teams.md): REST endpoints to list, get, create, update, and delete teams. - [Members](https://buildkite.com/docs/apis/rest-api/teams/members.md): REST endpoints to list, create, update, and delete team member associations. - [Pipelines](https://buildkite.com/docs/apis/rest-api/teams/pipelines.md): REST endpoints to list, create, update, and delete team-pipeline associations. - [Suites](https://buildkite.com/docs/apis/rest-api/teams/suites.md): REST endpoints to list, create, update, and delete team-suite associations. #### Test Engine - [Flaky tests](https://buildkite.com/docs/apis/rest-api/test-engine/flaky-tests.md): Deprecated REST endpoint for listing flaky tests; use the tests endpoint with label=flaky instead. - [Quarantine](https://buildkite.com/docs/apis/rest-api/test-engine/quarantine.md): REST endpoints to skip, mute, and enable tests for quarantine management. - [Runs](https://buildkite.com/docs/apis/rest-api/test-engine/runs.md): REST endpoints to list and get test suite runs. - [Suites](https://buildkite.com/docs/apis/rest-api/test-engine/suites.md): REST endpoints to list, get, create, update, and delete test suites. - [Tests](https://buildkite.com/docs/apis/rest-api/test-engine/tests.md): REST endpoints to list and get individual tests with filtering by label, state, and scope. ### GraphQL - [Overview](https://buildkite.com/docs/apis/graphql-api.md): GraphQL API overview: endpoint, authentication, explorer console, introspection, and IDs. - [Console and CLI tutorial](https://buildkite.com/docs/apis/graphql/graphql-tutorial.md): Tutorial for running GraphQL queries using the Buildkite console and command line. #### Cookbook - [Overview](https://buildkite.com/docs/apis/graphql/graphql-cookbook.md): Index of GraphQL recipe collections for agents, builds, clusters, pipelines, teams, and more. - [Agents](https://buildkite.com/docs/apis/graphql/cookbooks/agents.md): GraphQL recipes for listing agent tokens, searching agents, revoking tokens, and stopping agents. - [Artifacts](https://buildkite.com/docs/apis/graphql/cookbooks/artifacts.md): GraphQL recipes for listing artifact download URLs from builds. - [Builds](https://buildkite.com/docs/apis/graphql/cookbooks/builds.md): GraphQL recipes for querying builds by ID, listing builds, creating, canceling, and rebuilding. - [Clusters](https://buildkite.com/docs/apis/graphql/cookbooks/clusters.md): GraphQL recipes for listing, creating, updating, and deleting clusters and their queues. - [GitHub rate limits](https://buildkite.com/docs/apis/graphql/cookbooks/github-rate-limits.md): GraphQL recipes for checking GitHub API rate limits on repository providers. - [Hosted agents](https://buildkite.com/docs/apis/graphql/cookbooks/hosted-agents.md): GraphQL recipes for creating and managing Buildkite hosted agent queues. - [Jobs](https://buildkite.com/docs/apis/graphql/cookbooks/jobs.md): GraphQL recipes for querying jobs by queue, concurrency group, and other criteria. - [Pipelines](https://buildkite.com/docs/apis/graphql/cookbooks/pipelines.md): GraphQL recipes for creating, listing, updating, archiving, and deleting pipelines. - [Pipeline templates](https://buildkite.com/docs/apis/graphql/cookbooks/pipeline-templates.md): GraphQL recipes for listing, creating, updating, and deleting pipeline templates. - [Registries](https://buildkite.com/docs/apis/graphql/cookbooks/registries.md): GraphQL recipes for listing organization registries. - [Rules](https://buildkite.com/docs/apis/graphql/cookbooks/rules.md): GraphQL recipes for listing, creating, and deleting organization rules. - [Organizations](https://buildkite.com/docs/apis/graphql/cookbooks/organizations.md): GraphQL recipes for org ID lookup, member management, SSO, 2FA enforcement, and audit events. - [Teams](https://buildkite.com/docs/apis/graphql/cookbooks/teams.md): GraphQL recipes for creating, listing, updating, and deleting teams and their members. #### Portals - [Overview](https://buildkite.com/docs/apis/graphql/portals.md): Creating restricted GraphQL API endpoints (portals) with scoped operations for machine-to-machine use. - [Limits](https://buildkite.com/docs/apis/graphql/portals/limits.md): Portal API rate limits: 200 requests/min per org with response header details. - [Ephemeral portal tokens](https://buildkite.com/docs/apis/graphql/portals/ephemeral-portal-tokens.md): Generating short-lived ephemeral tokens for portal access instead of long-lived service tokens. - [User-invoked portals](https://buildkite.com/docs/apis/graphql/portals/user-invoked-portals.md): Allowing org members to execute portal operations under their own identity and permissions. - [Limits](https://buildkite.com/docs/apis/graphql/graphql-resource-limits.md): GraphQL query complexity limits, cost calculation, pagination guidance, and rate limiting. ### MCP server - [Overview](https://buildkite.com/docs/apis/mcp-server.md): Overview of the Buildkite MCP server (remote and local) for AI tool integration with Buildkite data. #### Tools - [Overview](https://buildkite.com/docs/apis/mcp-server/tools.md): List of available MCP tools organized by category: pipelines, builds, jobs, agents, test engine, and more. - [Toolsets](https://buildkite.com/docs/apis/mcp-server/tools/toolsets.md): Configuring MCP server toolsets to selectively enable categories of tools for AI agents. #### Remote MCP server - [Configuring AI tools](https://buildkite.com/docs/apis/mcp-server/remote/configuring-ai-tools.md): Configuring Amp, Claude, Cursor, VS Code, Windsurf, and other AI tools with the remote MCP server. - [Rate limits](https://buildkite.com/docs/apis/mcp-server/remote/rate-limits.md) #### Local MCP server - [Installing the server](https://buildkite.com/docs/apis/mcp-server/local/installing.md): Installing the local Buildkite MCP server using Docker, Homebrew, npm, or binary download. - [Configuring AI tools](https://buildkite.com/docs/apis/mcp-server/local/configuring-ai-tools.md): Configuring AI tools (Amp, Claude, Cursor, VS Code, and more) with the local MCP server. ### Webhooks - [Overview](https://buildkite.com/docs/apis/webhooks.md): Overview of outgoing webhooks for Pipelines, Test Engine, and Package Registries, plus incoming webhooks. #### Pipelines - [Overview](https://buildkite.com/docs/apis/webhooks/pipelines.md): Setting up pipeline webhooks, configuring tokens/signatures, and available HTTP headers. - [Build events](https://buildkite.com/docs/apis/webhooks/pipelines/build-events.md): Webhook event payloads for build.scheduled, build.running, build.failing, build.finished, build.skipped. - [Job events](https://buildkite.com/docs/apis/webhooks/pipelines/job-events.md): Webhook event payloads for job lifecycle events: scheduled, started, finished, activated. - [Agent events](https://buildkite.com/docs/apis/webhooks/pipelines/agent-events.md): Webhook event payloads for agent connection, disconnection, lost, and stop events. - [Ping events](https://buildkite.com/docs/apis/webhooks/pipelines/ping-events.md): Webhook ping event payload sent when notification settings change. - [Agent token events](https://buildkite.com/docs/apis/webhooks/pipelines/agent-token-events.md): Webhook event payload for blocked agent registration attempts due to IP restrictions. - [Integrations](https://buildkite.com/docs/apis/webhooks/pipelines/integrations.md): Third-party webhook integrations: AWS Lambda, Google Cloud Run, RequestBin, and Zapier. #### Test Engine - [Overview](https://buildkite.com/docs/apis/webhooks/test-engine.md): Test Engine webhooks triggered by workflow alarm/recover actions with JSON payloads. #### Package Registries - [Overview](https://buildkite.com/docs/apis/webhooks/package-registries.md): Webhooks triggered when packages are created in a registry, with setup and payload details. #### Incoming webhooks - [Pipeline triggers](https://buildkite.com/docs/apis/webhooks/incoming/pipeline-triggers.md): Incoming webhooks that create builds from external systems (GitHub, Linear, generic HTTP POST). ### Agent - [Overview](https://buildkite.com/docs/apis/agent-api.md): Agent REST API overview for metrics, stacks, and internal job endpoints on agent.buildkite.com. - [Metrics](https://buildkite.com/docs/apis/agent-api/metrics.md): Agent API endpoint returning idle/busy agent counts, job totals, and queue statistics. - [Stacks](https://buildkite.com/docs/apis/agent-api/stacks.md): Agent API endpoints for implementing a stack: acquiring jobs, starting agents, and heartbeats. - [Internal job](https://buildkite.com/docs/apis/agent-api/internal-job.md): Internal Unix socket API for querying and mutating job environment variables within a running agent. ### Model providers - [Overview](https://buildkite.com/docs/apis/model-providers.md): Overview of model providers for LLM access from pipelines, with Anthropic support and API key management. - [Anthropic](https://buildkite.com/docs/apis/model-providers/anthropic.md): Anthropic model provider setup: Claude Code compatibility, supported models, base URL, and usage in pipelines. ## See also - [Buildkite AI Tools and MCP Documentation](https://buildkite.com/docs/llms-ai-tools-and-mcp.txt): Buildkite documentation for AI tool integration, covering the MCP server (remote and local), available tools and toolsets, model providers, GraphQL portals, and configuring AI coding agents. - [Buildkite CLI Tools Documentation](https://buildkite.com/docs/llms-cli-tools.txt): Buildkite documentation for CLI tools, covering the Buildkite CLI (bk) for managing pipelines, builds, and agents, and the buildkite-agent CLI reference for agent operations, artifacts, meta-data, and pipeline uploads.