By enabling the GitLab Pipelines connector, you can analyze GitLab CI/CD pipelines and map them to your repositories and services. Please visit our schema explorer to see what data DX imports.

Before proceeding, please make sure that you have first enabled the GitLab connector by following the steps documented here. Each GitLab-related connection in DX should use a separate API token in order to avoid rate limit issues.

Prerequisites

To connect GitLab to DX, you need:

a GitLab account that can create a Group Access Token
if your GitLab instance is behind a firewall or has IP restrictions, you need to allowlist DX IP addresses

Setup instructions

Follow the steps below to connect GitLab to DX.

Step 1

Create a GitLab group access token to be used for the DX Data Cloud connection. Select Developer as the role and enable the read_api scope to grant API read access.

Step 2

Grant the Group access to projects to which you want to get pipelines imported.

Step 3

Navigate to the connector setup form in DX.
Enter the credentials you have generated in the previous steps—refer to the information below for errors and troubleshooting.

For GitLab-hosted instances, the GitLab API base URL should be https://gitlab.com/ without an organization name to the URL.

API Reference

The table below lists the specific API endpoints that are used by DX.

Endpoint URL	Documentation	Permissions Needed
groups	List Groups	Group access token with read_api scope
projects/#{project_id}/pipelines	List Project Pipelines	Group access token with read_api scope
projects/#{project_id}/pipelines/#{pipeline_id}	Get a Single Pipeline	Group access token with read_api scope
projects/#{project_id}/pipelines/#{pipeline_id}/jobs	List Pipeline Jobs	Group access token with read_api scope

Errors

The table below lists potential error codes when adding a connection in DX.

Error	Description
`invalid_credentials`	Your API credentials entered are not valid.
`invalid_permissions`	Your API token does not have the permissions required by DX.
`no_resources`	Your service account does not have access to any projects or repositories.