For the complete documentation index, see llms.txt. This page is also available as Markdown.

Bright Security

Connection Requirements

1 - Api Key

A Bright API key (authentication token). It is sent on every request in the Authorization: Api-Key <key> header, so it works like a password: anyone holding it can reach your Bright data with the scopes you granted.

Bright supports three key types — Organization, Project and Personal (user). An Organization key is recommended: it covers every project in the organization and is not tied to a single person's account, so discovery keeps working when that user leaves or loses permissions.

Discovery only reads data, so grant read action types only. The relevant read scopes are projects:read (projects and their issues), issues:read (detected scan issues) and org:read; add groups:read if your organization uses groups.

To create an Organization API key:

  1. Log in to Bright and open the Settings page, then select the API Keys tab.

  2. Click + Create API key.

  3. Enter a descriptive Name (e.g. octoxlabs-discovery).

  4. Select the Scopes listed above and set the Action types to read.

  5. Optionally set an Expiration date. The key stops working on that date and discovery starts failing, so choose a period you can track and renew it in time.

  6. Click Create, then copy the key right away — it is shown only once. As soon as you navigate away from the popup it cannot be restored, only a partial value stays visible on the API Keys tab.

  7. Paste the copied value into this field.

2 - Per Page

Number of records to fetch per request (default: 100). A lower value means more requests with smaller responses.

3 - Proxy

Proxy url to use while reaching the Bright API (optional, e.g. http://user:password@host:port).

4 - Timeout

The amount of time (in seconds) to wait for API responses (default: 30).

5 - Thread Count

This adapter works in a multi-threaded manner. This field represents the number of parallel threads that is going to be constructed for sending API requests (default: 32, min: 1, max: 32).

6 - Sleep Time

Delay in seconds between thread batches (optional, default: empty — no delay). Increase it if you encounter rate limit errors.

Last updated

Was this helpful?