Getting started

Welcome to the BugBase API. It lets you integrate BugBase security program data
and workflows into your own applications, systems, and automation.

1. Generate an API key

Open your Company API settings and
generate a key with only the scopes your integration needs. A key with any write
scope can be valid for at most 90 days.

Treat the key as a secret. Keep it in a server-side secret manager or environment
variable; never commit it or place it in browser code.

export BUGBASE_API_KEY='your-company-api-key'

2. Authenticate

Send the key as a Bearer token on every request:

curl --request GET 'https://api.bugbase.ai/programs' \
  --header 'Accept: application/json' \
  --header "Authorization: Bearer $BUGBASE_API_KEY"

The API key determines the company tenant. Resources belonging to another
company are returned as not found.

3. Select a program

Use GET /programs to obtain a program _id, then pass that value as
programId to program and report endpoints.

Base URL

All production requests use:

https://api.bugbase.ai

The older Stoplight example used api.bugbase.in; do not use that hostname for
new integrations.