You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|**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. |
12
-
|**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 Airbyte Engineering team to configure Airbyte |
|**Status**| Available to all Airbyte users (OSS, Cloud, Self-Hosted Enterprise). Learn more on our [blog](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. Users utilize the Config API, 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. |
The Airbyte API provides a way for developers to programmatically interact with Airbyte. It is available for all Airbyte products: Airbyte OSS, Cloud & Self-Hosted Enterprise.
8
+
9
+
Our API is a reliable, easy-to-use interface for programmatically controlling the Airbyte platform. It can be extended to:
10
+
11
+
- Enable users to control Airbyte programmatically and use with Orchestration tools (ex: Airflow)
12
+
- Enable [Powered by Airbyte](https://reference.airbyte.com/reference/powered-by-airbyte)
13
+
14
+
## Configuring API Access
15
+
16
+
View our documentation [here](./using-airbyte/configuring-api-access.md) to learn how to start using the Airbyte API.
17
+
18
+
## Using the Airbyte API
19
+
Navigate to our full API documentation to learn how to retrieve your access token, make API requests, and manage resources like sources, destinations, and workspaces.
20
+
21
+
Our full API documentation is located here: [api.airbyte.com](https://reference.airbyte.com/reference/getting-started).
22
+
23
+
## Configuration API (Deprecated)
24
+
The configuration API is now deprecated and no longer supported. It is an internal API that is designed for communications between different Airbyte components ratther than managing your Airbyte workspace.
25
+
26
+
Users utilize the Config API at their own risk. This API is utilized internally by the Airbyte Engineering team and may be modified in the future if the need arises.
0 commit comments