12 lines
5.7 KiB
Markdown
12 lines
5.7 KiB
Markdown
# API documentation
|
|
|
|
Airbyte has two sets of APIs which are intended for different uses. The table below outlines their descriptions, use cases, availability and status.
|
|
|
|
| | **Airbyte API** | **Configuration API** |
|
|
|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| **Description** | Airbyte API is a reliable, easy-to-use interface for programmatically controlling the Airbyte platform. With full support from the Airbyte team. | The Config API is an internal Airbyte API that is designed for communications between different Airbyte components. |
|
|
| **Use Cases** | Enables users to control Airbyte programmatically and use with Orchestration tools (ex: Airflow) <br /><br /> Exists for Airbyte users to write applications against. <br /><br /> Enables [Powered by Airbyte](https://airbyte.com/embed-airbyte-connectors-with-api) | Enables OSS users to configure their own Self-Hosted Airbyte deployment (internal state, etc) <br /><br /><br /> Enables Airbyte Engineering team to configure Airbyte Cloud (internal state) |
|
|
| **Available for** | Cloud users. | OSS users |
|
|
| **Status** | Available to all Cloud users. Learn more in our [launch post](https://airbyte.com/blog/airbyte-api). <br /><br /> Full support from the Airbyte team. | Airbyte does NOT have active commitments to support this API long-term. OSS users can utilize the Config API, but at their own risk. <br /><br /> This API is utilized internally by the Airbyte Engineering team and may be modified in the future if the need arises. <br /><br /> Modifications by the Airbyte Engineering team could create breaking changes and OSS users would need to update their code to catch up to any backwards incompatible changes in the API. |
|
|
| **Documentation** | [Available here](https://api.airbyte.com) | [Available here](https://airbyte-public-api-docs.s3.us-east-2.amazonaws.com/rapidoc-api-docs.html)
|