Skip to main content

How to set up Airbyte

Connect Airbyte Cloud or a self-hosted Airbyte to Foundational to extract column-level lineage for the tables Airbyte loads into your warehouse.

Setup takes about 10 minutes.

Introduction

Connecting Airbyte to Foundational allows Foundational to extract lineage for the data Airbyte loads into your warehouse.

Foundational reads your Airbyte configuration through the Airbyte public API. Foundational supports Airbyte Cloud and a self-hosted Airbyte that Foundational can reach over HTTPS.

To make the connection, you need to:

  • Create an Application in Airbyte

  • Connect Foundational to Airbyte using the on-screen wizard​

What lineage you get

  • Every selected stream becomes a destination table in your catalog, defined by Airbyte.

  • Sources and destinations from Airbyte appears in your lineage graph with proper edges connecting those, according to Airbyte configuration.​

Prerequisites

Ensure you have:

  • An Airbyte Cloud account, or a self-hosted Airbyte that is reachable from Foundational over HTTPS.

  • Added Foundational IP addresses to your allowlist, if your Airbyte sits behind a firewall. See the article Alowing IP access to Foundational.

  • Permission to create an Application in Airbyte.​

Access permissions

Foundational only reads from Airbyte. It never changes your connections, sources or destinations.

The permissions you assign to Foundational enable it to:

  • List the workspaces and connections the Application can see

  • Read the configurations (only) for sources and destinations

  • Read the stream catalog of each connection, which is where column names come from

An Airbyte access token carries the same permissions as the user who created the Application. For that reason, create the Application from a dedicated service-account user that has only the access listed above, rather than from a personal admin account.

Create an Application in Airbyte

  1. In Airbyte, open Settings, then Applications.

  2. Click Create an application and give it a name, for example Foundational.

  3. Copy the Client ID and the Client Secret. The secret is shown only once, so store it before leaving the page.

Connect Foundational to Airbyte

  1. In Foundational, open the Connectors and Integrations page.

  2. In ETL, select the Airbyte card and click Connect.

  3. The initial setup screen opens. Click Start Setup.

  4. The Set Up New Connection screen opens. Enter the details:

    • Account Name: a name that identifies this connector. Letters, numbers and underscores only.

    • Deployment: choose Airbyte Cloud or Self-hosted Airbyte. Airbyte Cloud is the default.

    • Airbyte server URL: shown only when you choose Self-hosted. Enter the base URL of your Airbyte server, for example https://airbyte.example.com. Foundational appends /api/public/v1 for you. The URL must use HTTPS.

    • Client ID and Client Secret: the values from the Application you created.

  5. Click Next.

  6. The final setup screen opens. To complete the connection, click Save.

That's it. Foundational is now connected to Airbyte, and the first scan starts automatically.

Troubleshooting

If the connection cannot be validated, Foundational shows one of these messages:

  • Invalid Client ID or Client Secret: the credentials are wrong, or the Application was deleted in Airbyte. Create a new Application and enter the new values.

  • Could not reach Airbyte at ...: Foundational cannot open a connection to the server URL. Check that the host resolves publicly and that Foundational's IP addresses are allowed through your firewall.

  • ... does not look like an Airbyte public API: the URL points somewhere other than an Airbyte server. Enter the base URL of Airbyte itself, without a path.

  • The server URL must start with https: plain HTTP is refused, because the Client Secret would travel in the clear.

Did this answer your question?