BuildKite

BuildKite is a continuous integration and continuous delivery (CI/CD) platform that enables software development teams to automate their build, test, and deployment pipelines. As a hybrid CI/CD solution, BuildKite provides a cloud-based interface for managing pipelines while allowing builds to run on your own infrastructure using BuildKite agents.

Category	Source control & CI/CD
Direction	Query source
Sign-in	API Token
Query languages	SQLite
Tables	6
Query templates	17
Website	buildkite.com

Before you start

Huntbase signs in to BuildKite with API Token. Create the credential in BuildKite first, then keep it to hand for the Connect step.

1. In Buildkite, select Personal Settings in the global navigation, then API Access Tokens, then New API Access Token.
2. Under Organization Access, select the organization the token should have access to.
3. Under REST API Scopes, select only the read scopes listed below.
4. Create the token and copy its value from the resulting page. You won't see it again.

Permissions:

• read_agents
• read_artifacts
• read_build_logs
• read_builds
• read_job_env
• read_organizations
• read_pipelines
• read_teams
• read_user

Watch out for

• Leave Enable GraphQL API access off. It grants full access with no per-feature restrictions.

For the vendor's own instructions, see Buildkite API access token documentation.

tip

Use a dedicated, read-only credential for Huntbase where the product allows it. Huntbase only needs to read.

Connect BuildKite

1. Go to Connections and click New connection, or click New connection on the BuildKite product page.
2. On Product, pick BuildKite and choose the Owner.
3. On Details, give the connection a Name and, optionally, a Description.
4. On Connect, fill in the settings and credentials described below.
5. On Verify, review the summary and click Create & check.

For everything else on the setup page — saving a draft, I'll do this later, and what each check result means — see Connections.

Credentials

The only Method is API Token. Enter a Credential label (for example Production), then fill in:

Field	Required	Notes
API Token	Yes	Secret — not shown again after you save it.

Query it

Once connected, BuildKite can serve these languages in a query tab, and Scout can use it when you ask in Auto:

Language	Use it for
SQLite	SQL over the 6 tables listed below, alongside every other connected source.

Example: SQLite

Get user info — Explore the details of all users in the Buildkite system to understand their roles and permissions.

select
  *
from
  buildkite_user

BuildKite ships with 17 query templates. Find them in Library › Queries — see Query templates.

Tables

BuildKite adds 6 tables. Browse their columns from Schema in the query bar's ⋯ menu.

All 6 tables

Table	Contains
buildkite_agent	Agents in the Buildkite account.
buildkite_build	Builds in the Buildkite account.
buildkite_organization	Organizations in the Buildkite account.
buildkite_pipeline	Pipelines in the Buildkite account.
buildkite_team	Teams in the Buildkite account.
buildkite_user	User in the Buildkite account.

Next steps

• Connections — health, credentials and settings after you connect
• Query languages — syntax, parameters and time ranges
• Chatting with Scout — ask questions without writing a query
• All integrations — the rest of the catalog