Skip to main content

GitGuardian

Overview​

The GitGuardian source connector is currently in development.

At this time, the connector supports:

  • Authentication / credential validation using a GitGuardian API key.

It does not yet support:

  • Discovering a catalog (streams)
  • Extracting data

Requirements​

  • A GitGuardian account with access to generate an API key.
  • Network access to https://api.gitguardian.com.

Authentication​

This connector authenticates using a GitGuardian API key sent as an HTTP Authorization header in the format:

Authorization: Token <api_key>

Create an API key in GitGuardian​

  1. In GitGuardian, generate an API key (sometimes labeled as a personal access token or API token depending on your plan/UI).
  2. Copy the key and store it securely.

Setup​

  1. In your workspace, add a new GitGuardian source.
  2. Paste your GitGuardian API key into the API Key field.
  3. Save and test the connection.

During the connection test, the connector calls:

  • GET https://api.gitguardian.com/v1/healthcheck

If the request succeeds, credentials are considered valid.

Configuration reference​

FieldTypeRequiredDescription
api_keystringYesGitGuardian API key used to authenticate requests.

Streams​

No streams are currently available. The connector’s catalog is empty while extraction is under development.

Limitations​

  • Extraction is not implemented yet. Runs will fail with an “in development” error if extraction is attempted.
  • No catalog discovery. The connector currently returns an empty catalog.