> For the complete documentation index, see [llms.txt](https://docs.paradime.io/app-help/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.paradime.io/app-help/integrations/airbyte/airbyte-server.md).
# Airbyte Server
To connect Airbyte Server to Paradime, you will need to configure the connection with your self-hosted Airbyte instance credentials. See also the [Airbyte documentation](https://docs.airbyte.com/).
### Prerequisites
Before connecting Airbyte Server to Paradime, ensure you have:
* A self-hosted Airbyte Server instance that can be accessed from the Internet
* Access to the Airbyte Server API container
* Network access from Paradime to your Airbyte Server instance
### Host Configuration
The Airbyte URL must include the correct port number based on your Airbyte Server version:
* **Airbyte Server v0.59.1 and later**: The API is exposed on port `8000` or `8001`. Your `AIRBYTE_HOST` should look like `https://your-server:8000` or `https://your-server:8001`.
* **Airbyte Server prior to v0.59.1**: The API is started on port `8006`. Your `AIRBYTE_HOST` should look like `https://your-server:8006`.
Unless you have exposed the API server on port 80 or 443, you must include the port number in the Airbyte Server URL.
{% hint style="info" %}
Paradime connects to your running Airbyte API container. Ensure your Airbyte Server is configured to expose the API on the appropriate port. Airbyte recommends using a reverse proxy or load balancer to direct API traffic to the correct port.
{% endhint %}
### Network Configuration
#### Whitelisting IPs
Paradime will need to be whitelisted to access the Airbyte Server API if you use a network policy. Please refer to the [IP whitelist documentation](/app-help/developers/ip-restrictions.md) for the current list of Paradime IPs that need to be allowed through your firewall.
#### Authentication Methods
Airbyte Server supports two authentication methods:
* **Client ID and Secret**: Supported on Airbyte Server v1.0 and onwards. Set `AIRBYTE_AUTH_TYPE` to `client_credentials`. Client credentials can be found in the **Applications** view in your Airbyte Server settings.
If you are running a local instance of Airbyte Server, you can also retrieve credentials by running `abctl local credentials`.
### Connect the Airbyte Server Integration
The Airbyte Server integration can be connected by a Paradime Admin user. To enable the integration, you will need to set your Airbyte Server credentials as environment variables in Paradime before connecting the integration.
#### Steps to Connect
1. In Paradime, go to [Paradime Account Settings > Environment Variables](/app-help/documentation/settings/environment-variables/bolt-schedule-env-variables.md)
2. Create the required environment variables with the following names and values:
* `AIRBYTE_BASE_URL` - The URL of your Airbyte Server API endpoint (including the correct port number)
* `AIRBYTE_CLIENT_ID` - The client ID of your Airbyte Server application (required for client credentials auth)
* `AIRBYTE_CLIENT_SECRET` - The client secret of your Airbyte Server application (required for client credentials auth)
* `USE_SERVER_AUTH` - Set to `TRUE` to use authentication for self-hosted Airbyte Server (instead of OAuth for Cloud)
3. Click **Save** to store the environment variables.
### Authentication Parameters
| Environment Variable | Type | Required | Information |
| ----------------------- | ----------------- | -------- | ----------------------------------------------------------------------------------------------- |
| AIRBYTE\_BASE\_URL | string (url) | Yes | The URL of your Airbyte Server API endpoint including the correct port number |
| AIRBYTE\_CLIENT\_ID | string | Yes | The client ID of your Airbyte Server application |
| AIRBYTE\_CLIENT\_SECRET | string (password) | Yes | The client secret of your Airbyte Server application |
| USE\_SERVER\_AUTH | boolean | Yes | Set to `TRUE` to use authentication for self-hosted Airbyte Server (instead of OAuth for Cloud) |
Make sure all required environment variables are set in your Paradime Account Settings > Environment Variables before attempting to trigger the Airbyte Sync.
### Airbyte Server Integration Capabilities
Paradime uses the Airbyte Server API to trigger [Airbyte syncs](/app-help/documentation/bolt/creating-schedules/command-settings/airbyte-connector-sync.md) from [Bolt](/app-help/documentation/bolt/creating-schedules/command-settings/airbyte-connector-sync.md). This allows you to orchestrate your Airbyte data pipelines as part of your Paradime workflows, enabling:
* Triggering Airbyte connections on-demand from Bolt
* Monitoring sync status and job execution
* Integrating Airbyte syncs into larger data orchestration workflows
* Error handling and retry logic for failed syncs
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.paradime.io/app-help/integrations/airbyte/airbyte-server.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.