Jump to Content

API Docs

All

Pages

Start typing to search…

Airbyte API

Getting Started
Standalone Server Deprecation and Migration to Airbyte Server
Authentication
portal.airbyte.com deprecation
Terraform Provider and SDKs
Error Messages
Migration Guides

Setup Guides

Airbyte Embedded
How to Create OAuth Sources
Airbyte Terraform Provider

Helpful Links

❓ Technical Help
📖 Airbyte Docs

Applications

List Applicationsget
Create an Applicationpost
Get an Application detailget
Deletes an Applicationdelete
Get an Access Tokenpost

Sources

List sourcesget
Get Source detailsget
Create a sourcepost
Update a Source and fully overwrite itput
Update a Sourcepatch
Delete a Sourcedelete
Initiate OAuth for a sourcepost

Destinations

List destinationsget
Create a destinationpost
Get Destination detailsget
Delete a Destinationdelete
Update a Destinationpatch
Update a Destination and fully overwrite itput

Connections

Create a connectionpost
List connectionsget
Get Connection detailsget
Update Connection detailspatch
Delete a Connectiondelete

Jobs

List Jobs by sync typeget
Trigger a sync or reset job of a connectionpost
Get Job status and detailsget
Cancel a running Jobdelete

Tags

List all tagsget
Get a tagget
Update a tagpatch
Delete a tagdelete
Create a tagpost

Streams

Get stream propertiesget

Workspaces

List workspacesget
Get Workspace detailsget
Create a workspacepost
Update a workspacepatch
Delete a Workspacedelete
Create OAuth override credentials for a workspace and source type.put

Permissions

Get Permission detailsget
Update a permissionpatch
Delete a Permissiondelete
List Permissions by user idget
Create a permissionpost

Users

List all users within an organizationget

Organizations

List all organizations for a userget
Create OAuth override credentials for an organization and source type.put

Health

Health Checkget

Source Definitions

List source definitions.get
Get source definition details.get
Create a source definition.post
Update source definition details.put
Delete a source definition.delete

Destination Definitions

List destination definitions.get
Get destination definition details.get
Create a destination definition.post
Update destination definition details.put
Delete a destination definition.delete

Declarative Source Definitions

List declarative source definitions.get
Get declarative source definition details.get
Create a declarative source definition.post
Update declarative source definition details.put
Delete a declarative source definition.delete

Config Templates

List config templatesget
Create config templatepost
Update a config templatepatch
Get a Config Template by id.get

Embedded Widget

Get a token for Airbyte Embeddedpost

Delete a Workspace

delete https://api.airbyte.com/v1/workspaces/{workspaceId}

Language

Credentials

Bearer

JWT

Click Try It! to start a request and see the response here!