can i access the api from airbyte oss ?

Yes, you can access the API from Airbyte Open Source Software (OSS). However, the process to set up the API with OSS might be different from the Enterprise/Cloud version. Here are the general steps to access the API in Airbyte: 1. Ensure you have an up and running deployment of Airbyte that exposes the

airbyte-server

service. 2. While logged into the Airbyte UI, go to the

settings/applications

page, then create an application to get a pair of

client_id

and

client_secret

credentials. 3. With your

client_id

and

client_secret

in hand, make the following API request, replacing

<YOUR_WEBAPP_URL>

with the URL you use to access the Airbyte UI:

bash POST <YOUR_WEBAPP_URL>/api/v1/applications/token

4. Attach the following JSON Body to the request, populated with your

client_id

and `client_secret`:

json { "client_id": "", "client_secret": "" }

5. The API response should provide an

access_token

which is a Bearer Token valid for 60 minutes that can be used to make requests to the API. Once your

access_token

expires, you may make a new request to the

applications/token

endpoint to get a new token. Please note that the API access is controlled via application keys which are tied to individual users and their respective permissions. These credentials do not expire, but may be deleted at any time. For more detailed instructions, please refer to the [official documentation](https://docs.airbyte.com/enterprise-setup/api-access-config). If you are looking for specific instructions on how to set up the API with OSS, it seems that the documentation was missing at some point but has been restored. You can find the updated documentation on using the Airbyte API [here](https://reference.airbyte.com/reference/getting-started) as mentioned in this [discussion](https://github.com/airbytehq/airbyte/discussions/40552).

@kapa.ai I am using abctl and I am unable to setup a source for a local database on the host machine at the address localhost:5432. It appears that airbyte running with abctl is not capable of networking with the host machine by default. Can you provide instructions or documentation on how to connect to service running on the host machine from within an abctl instance.

Based on the knowledge sources provided, it seems that you're having trouble connecting Airbyte to a local database running on your host machine. This issue might be due to your networking setup. Here are some general steps you can follow to verify your connection: 1. Make sure your database is accessible from the machine running Airbyte. This is dependent on your networking setup. The easiest way to verify if Airbyte is able to connect to your database instance is via the check connection tool in the UI. This applies to various databases like [SingleStore](https://docs.airbyte.com/integrations/sources/singlestore#1-make-sure-your-database-is-accessible-from-the-machine-running-airbyte), [CockroachDB](https://docs.airbyte.com/integrations/sources/cockroachdb#1-make-sure-your-database-is-accessible-from-the-machine-running-airbyte), [TiDB](https://docs.airbyte.com/integrations/sources/tidb#1-make-sure-your-database-is-accessible-from-the-machine-running-airbyte), [ClickHouse](https://docs.airbyte.com/integrations/sources/clickhouse#1-make-sure-your-database-is-accessible-from-the-machine-running-airbyte), and [Postgres](https://docs.airbyte.com/integrations/sources/postgres#step-3-airbyte-cloud-only-allow-inbound-traffic-from-airbyte-ips). 2. If you are on Airbyte Cloud, you will always need to modify your database configuration to allow inbound traffic from Airbyte IPs. You can find a list of all IPs that need to be allowlisted in the [Airbyte Security docs](https://docs.airbyte.com/operating-airbyte/security#network-security-1). 3. After modifying your database configuration, click

Set up source

in the Airbyte UI. Airbyte will now test connecting to your database. Once this succeeds, you've configured an Airbyte source! If you're still having trouble, there's an open issue on GitHub where a user had a similar problem connecting to a locally running Google Cloud SQL Proxy. You might find the discussion and potential solutions helpful. Here's the [link to the issue](https://github.com/airbytehq/airbyte/issues/24751). Please note that these are general steps and might not solve your specific issue. If you continue to experience problems, I recommend reaching out to the Airbyte community or support for more specific guidance.

@kapa.ai not quite, I'm referring to an airbyte instance that is running via abctl which is the replacement of the docker-compose version of running airbyte.

A message from kapa.ai