Skip to content

Commit

Permalink
docs: add oss api access information (#50402)
Browse files Browse the repository at this point in the history
Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>
  • Loading branch information
jfpaccini and marcosmarxm authored Jan 10, 2025
1 parent 81f0796 commit 2607049
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions docs/api-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

:::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`)
:::

## 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.

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.
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.

0 comments on commit 2607049

Please sign in to comment.