jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2025-12-25 02:09:19 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: add oss api access information (#50402)

Browse Source 
Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>
This commit is contained in:
Jean-François Paccini
2025-01-10 17:52:15 +01:00
committed by GitHub
parent 81f0796e52
commit 2607049535
1 changed files with 13 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/api-documentation.md
View File

@@ -4,23 +4,29 @@ products: all
# API documentation
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.
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.
Our API is a reliable, easy-to-use interface for programmatically controlling the Airbyte platform. It can be extended to:
Our API is a reliable, easy-to-use interface for programmatically controlling the Airbyte platform. It can be extended to:
- Enable users to control Airbyte programmatically and use with Orchestration tools (ex: Airflow)
- Enable [Powered by Airbyte](https://reference.airbyte.com/reference/powered-by-airbyte)
## Configuring API Access
View our documentation [here](./using-airbyte/configuring-api-access.md) to learn how to start using the Airbyte API.
View our documentation [here](./using-airbyte/configuring-api-access.md) to learn how to start using the Airbyte API.
## Using the Airbyte API
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.
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.
Our full API documentation is located here: [api.airbyte.com](https://reference.airbyte.com/reference/getting-started).
## Configuration API (Deprecated)
The configuration API is now deprecated and no longer supported. It is an internal API that is designed for communications between different Airbyte components rather than managing your Airbyte workspace.
:::note
Only for OSS users, to access the API in the OSS edition, you need to use the `/api/public/v1` path prefix. (ex: retrieve list of workspaces with `curl http://localhost:8000/api/public/v1/workspaces`)
:::
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.
## Configuration API (Deprecated)
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.
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.