setup

Airbyte

Purpose

Ingests Airbyte organizations, workspaces, users, sources, destinations, tags, and connections into SubImage to map your data-pipeline footprint and its integrations with external systems.

tip

Secret fields below accept either an AWS Secrets Manager ARN or a value pasted directly into SubImage's managed vault. See Secrets for details.

Required Fields

Field Secret? Description
airbyte_client_id No Airbyte application client ID
airbyte_client_secret Yes Airbyte application client secret
airbyte_api_url No Airbyte API base URL (default https://api.airbyte.com/v1, override for self-hosted)

Setup Steps

  1. In the Airbyte admin panel, open Settings → Applications and create a new application. The application inherits the permissions of the creating user — use an account with at least read access to every organization and workspace you want to sync. Copy the Client ID and Client Secret.
  2. In SubImage, fill in:
    • airbyte_client_id — the Client ID
    • airbyte_client_secret — the Client Secret (or its AWS Secret ARN)
    • airbyte_api_url — leave empty for Airbyte Cloud; set your base URL (e.g. https://airbyte.internal/api/public/v1) for self-hosted
  3. Save the module.

SubImage exchanges the client credentials for a short-lived access token at sync time.

Notes

  • If the application's owning user loses access to an organization or workspace, that scope silently drops from the sync. Use a stable service account.