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

Codebase

Connection Requirements

1 - Domain

The domain of the Codebase host (default: api3.codebasehq.com).

2 - Account

Your Codebase account name. This value is used together with the username for authentication.

3 - Username

Username of your Codebase account used for API authentication.

4 - API Key

Personal API key generated from your Codebase account profile. This key is used as the password for HTTP Basic Authentication.

Creating an API Key

You can generate your API key from your Codebase account settings:

  1. Log in to your Codebase account

  2. Navigate to Settings > My Profile

  3. Generate or copy your personal API key

5 - Proxy

Proxy URL (optional).

6 - Timeout

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

7 - Is Secure

Choose this if your connection is going to be over HTTPS (optional, default: True).

8 - Fetch Source Codes

When enabled, repository source code information will be retrieved during discovery. (default: Enabled)

9 - Fetch Users

When enabled, user information from the Codebase account will be retrieved. (default: Disabled)

Last updated