The method for authentication differs slightly between Airbyte Cloud and OSS

Airbyte Cloud Users

To create an API Key, head over to your Developer Portal and select API Keys on the sidebar.

When creating an API Key, you'll be asked to give it a name - which cannot be changed later. We'll only show you your API Key once, so make sure you store it somewhere safe. You can also remove unused keys from the list of keys in the API Keys tab.

Once you have your API Key, simply provide it as an Authorization request header using a 'Bearer' authentication scheme:

curl --location --request \
GET 'https://api.airbyte.com/v1/connections/' \
--header 'Authorization: Bearer {API_KEY}'

πŸ“˜

User Association

API Keys created in the Developer Portal are associated with the user you log in as. For instance, if someone logs into the Developer Portal with [email protected] and creates an API Key, all requests with that key will be made by [email protected].

Authentication in Airbyte Self-Managed Enterprise

Information regarding getting bearer tokens for added here soon. In the meantime, please reach out to our support team.

Authentication in OSS

If you use the Airbyte API in OSS, you can use the credentials set for your UI instance. To do this, you should use the Basic authentication, with the username and password separated by a colon and Base64 encoded like the following:

curl --location --request \
GET 'https://api.my-airbyte-host.com/v1/connections/' \
--header 'Authorization: Basic YWlyYnl0ZTpwYXNzd29yZA=='