For AI agents: visit https://reference.airbyte.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Airbyte APILog In
API Docs
Log InAirbyte API
API Docs

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 Applicationdel
  • 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 Sourcedel
  • Initiate OAuth for a sourcepost

Destinations

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

Connections

  • Create a connectionpost
  • List connectionsget
  • Get Connection detailsget
  • Update Connection detailspatch
  • Delete a Connectiondel

Jobs

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

Tags

  • List all tagsget
  • Get a tagget
  • Update a tagpatch
  • Delete a tagdel
  • Create a tagpost

Streams

  • Get stream propertiesget

Workspaces

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

Permissions

  • Get Permission detailsget
  • Update a permissionpatch
  • Delete a Permissiondel
  • 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.del

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

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.del
Powered by 

Terraform Provider and SDKs

Terraform Provider and SDKs available for the Airbyte API

Terraform Provider

  • Airbyte Terraform Provider

Java SDK

  • Java SDK Maven Package
  • Java SDK GitHub Repository

Python SDK

  • Python PyPi Package
  • Python SDK GitHub Repository

Updated over 1 year ago


portal.airbyte.com deprecation
Error Messages
Did this page help you?

Updated over 1 year ago


portal.airbyte.com deprecation
Error Messages
Did this page help you?
    • Terraform Provider
    • Java SDK
    • Python SDK