Skip to main content

GitLab source

Use the GitLab source connector to connect to the GitLab REST API using a Personal Access Token (PAT).

Setup​

Prerequisites​

  • A GitLab account (GitLab.com or self-managed GitLab)
  • A GitLab Personal Access Token with sufficient permissions to read the resources you plan to sync

Create a Personal Access Token (PAT)​

  1. In GitLab, go to User Settings → Access Tokens.
  2. Create a token with appropriate scopes (for example, read_api).
  3. Copy the token value—this is shown only once.

Authentication​

This connector authenticates using a GitLab Personal Access Token sent via the PRIVATE-TOKEN request header.

During connection testing, the connector validates credentials by calling the GitLab API endpoint:

  • GET {api_url}/user

If the request fails, the connector will report a credential validation error.

Configuration​

FieldTypeRequiredDescription
api_urlstring✅Base URL for the GitLab API. For GitLab.com, use https://gitlab.com/api/v4. For self-managed GitLab, use your instance API base URL (for example, https://gitlab.example.com/api/v4). If you omit the scheme, https:// is assumed.
personal_access_tokenstring✅GitLab Personal Access Token (PAT).

URL requirements​

  • api_url must be a valid HTTP URL using http or https.
  • Trailing slashes are allowed; they are ignored when building requests.

Streams​

This connector is currently under development and does not yet extract any streams. Connection testing (credential validation) is supported, but sync/extraction is not yet available.