Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update API page #23519

Merged
merged 1 commit into from
Feb 27, 2023
Merged

Update API page #23519

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 8 additions & 20 deletions docs/api-documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,10 @@
# API documentation

## Open-Source API

Airbyte Open Source doesn't require an API Token for Authentication.
All endpoints are acccessible without the token.

:::caution

Our Open-Source API (configuration API) is still in an alpha state and might change. You won’t lose any functionality, but you may need to update your code to catch up to any backwards incompatible changes in the API.
:::

**Check out the** [**Open-Source API documentation**](https://airbyte-public-api-docs.s3.us-east-2.amazonaws.com/rapidoc-api-docs.html)**.**

Contact us on [Slack](https://slack.airbyte.io) if you have any questions about it.

---

## Airbyte Cloud API

Airbyte Cloud will support API access in 2023. See [Airbyte roadmap](https://app.harvestr.io/roadmap/view/pQU6gdCyc/airbyte-roadmap) for more details.

Airbyte has 2 APIs. Please see the table below for differences between them.

| **Configuration API** | **Airbyte API** |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Purpose:** Enables OSS users to configure their own Self-Hosted Airbyte deployment (ex UI, internal state, etc) | **Purpose:** Enables users to control Airbyte programmatically and use with Orchestration tools (ex: Airflow) |
| **Purpose:** Enables Airbyte team to configure Airbyte Cloud (ex UI, internal state, etc) | **Purpose:** Exists for Airbyte users to write applications against and enable [Powered by Airbyte](https://airbyte.com/embed-airbyte-connectors-with-api) (Headless version and UI version) |
| **Status:** Alpha state and might change. You won’t lose any functionality, but you may need to update your code to catch up to any backwards incompatible changes in the API. | **Status:** Closed Beta. See [Airbyte roadmap](https://app.harvestr.io/roadmap/view/pQU6gdCyc/airbyte-roadmap) for more details. |
| **Documentation** [Available here](https://airbyte-public-api-docs.s3.us-east-2.amazonaws.com/rapidoc-api-docs.html) | **Documentation:** Available to Closed Beta participants. |