Authentication #

export BUILDKITE_ACCESS_TOKEN=<your_api_token>

set BUILDKITE_ACCESS_TOKEN=<your_api_token>

Example Config #

kind: source
# Common source-plugin configuration
spec:
  name: buildkite
  path: cloudquery/buildkite
  version: "v1.0.0"
  tables: ["*"]
  destinations: ["postgresql"]
  # buildkite specific configuration
  spec:
    access_tokens: ["${BUILDKITE_ACCESS_TOKEN}"]

    # optional parameters
    # base_url: "https://api.buildkite.com/"
    # concurrency: 100
    # scheduler: "dfs"
    # requests_per_minute: 160

Configuration #

• access_tokens ([]string) (required)

  Buildkite API Acces token. Can be obtained by generating an access token.
• base_url (string) (optional)

  The base URL to use for the Buildkite API. Defaults to https://api.buildkite.com/
• concurrency (integer) (optional) (default: 100)

  A best effort maximum number of Go routines to use. Lower this number to reduce memory usage.
• scheduler (string, optional, default: dfs)

  The scheduler to use when determining the priority of resources to sync. Supported values are dfs (depth-first search), round-robin, shuffle and shuffle-queue.

  For more information about this, see performance tuning.
• requests_per_minute (integer) (optional)

  The maximum number of requests per minute that can be made to the Buildkite API. BuildKite API rate limit default is 200 requests per minute for each organization. CloudQuery by default uses 80% of the rate limit, to allow for other requests to be made to the API.
• table_options (map) (default: null)

  A set of options to override the defaults for certain tables. The full list of supported options are documented under the Table Options section of each table

  The format of the table_options object is as follows:

  table_options:
    <table_name>:
      <input_object>

  table_options:
    buildkite_agents:
      include_access_token: true # default: false
    buildkite_pipelines:
      include_env_vars: true # default: false
    buildkite_builds:
      ListBuilds:
        - include_env_vars:  true # default: false
          created_from: "2 days ago"
          created_to: "1 day ago"
        - include_env_vars: false
          branch: ["dev", "feature1"]

Time in table options

• now
• x seconds [ago|from now]
• x minutes [ago|from now]
• x hours [ago|from now]
• x days [ago|from now]

• until: now
• until: 2 days ago
• until: 10 months 3 days 4h20m from now
• until: 2024-01-01T12:00:00+00:00