dbt Connection
This article describes how to connect to dbt Cloud for lineage extraction.
See also dbt Lineage Scanner.
Prerequisites
-
Review how sources and connections work.
-
Create a source to add this connection to.
-
A dbt Cloud account with API access. You need a service account token to authenticate to dbt Cloud APIs.
Add a connection
-
Go to [your source] > Connections and select Add Connection.
-
In Connection type, select dbt.
-
Fill in the following:
-
Name: A meaningful name for your connection. Used to indicate the location of catalog items.
-
Description (Optional): A short description of the connection.
-
Admin API URL: The base URL of the dbt Cloud Administrative API for your region. See API endpoints.
-
Discovery API URL: The GraphQL endpoint of the dbt Cloud Discovery API for your region. See API endpoints.
-
API endpoints
The Admin API URL depends on which dbt Cloud region your account is hosted in:
| Region | Admin API URL |
|---|---|
Production (US, multi-tenant) |
|
Production (EMEA) |
|
Production (AU) |
The Discovery API URL is the corresponding metadata endpoint for your region (for example, https://metadata.cloud.getdbt.com/graphql for the US multi-tenant region).
| For region-specific endpoints and the most current information about deployment regions, see Administrative API and Query the Discovery API in the dbt documentation. |
Add credentials
| Only Token authentication is currently supported. |
-
Select Add Credentials.
-
Fill in the following:
-
Name: Provide a clear name for this set of credentials.
-
Description (Optional): Explain what the credentials are used for or provide other useful information.
-
Token: The service account token generated in dbt Cloud.
To create a service account token, in dbt Cloud go to Account settings > Service tokens and select New token. Assign the token the permissions required to read the projects you want to extract lineage from. For details, see Service account tokens in the dbt documentation.
-
-
To use this set of credentials by default when connecting to the data source, select Assign as default.
| Always use the dedicated credential fields for authentication details such as passwords, secrets, and tokens. This ensures credentials are handled with the appropriate level of protection and reliably preserved across environments. |
| One set of credentials must be defined as default for each connection. Otherwise, DQ evaluation fails and previewing data in the catalog is not possible. |
Was this page useful?