Airbyte

Airbyte Configuration API

Airbyte Configuration API [https://airbyte.io](https://airbyte.io). This API is a collection of HTTP RPC-style methods. While it is not a REST API, those…

Developer tools#openapi#developer-tools

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Airbyte Configuration API
https://airbyte.io.

This API is a collection of HTTP RPC-style methods. While it is not a REST API, those familiar with REST should find the conventions of this API recognizable.

Here are some conventions that this API follows:

  • All endpoints are http POST methods.
  • All endpoints accept data via application/json request bodies. The API does not accept any data via query params.
  • The naming convention for endpoints is: localhost:8000/{VERSION}/{METHOD_FAMILY}/{METHOD_NAME} e.g. localhost:8000/v1/connections/create.
  • For all update methods, the whole object must be passed in, even the fields that did not change.

Authentication (OSS):

  • When authenticating to the Configuration API, you must use Basic Authentication by setting the Authentication Header to Basic and base64 encoding the username and password (which are airbyte and password by default - so base64 encoding airbyte:password results in YWlyYnl0ZTpwYXNzd29yZA==). So the full header reads 'Authorization': "Basic YWlyYnl0ZTpwYXNzd29yZA=="

Endpoints 102

workspace

  • POSTCreates a workspace/v1/workspaces/create
  • POSTDeletes a workspace/v1/workspaces/delete
  • POSTFind workspace by ID/v1/workspaces/get
  • POSTFind workspace by connection id/v1/workspaces/get_by_connection_id
  • POSTFind workspace by slug/v1/workspaces/get_by_slug
  • POSTList all workspaces registered in the current Airbyte deployment/v1/workspaces/list
  • POSTUpdate workspace feedback state/v1/workspaces/tag_feedback_status_as_done
  • POSTUpdate workspace state/v1/workspaces/update
  • POSTUpdate workspace name/v1/workspaces/update_name

source_definition

  • POSTCreates a custom sourceDefinition for the given workspace/v1/source_definitions/create_custom
  • POSTDelete a source definition/v1/source_definitions/delete
  • POSTGet source/v1/source_definitions/get
  • POSTGet a sourceDefinition that is configured for the given workspace/v1/source_definitions/get_for_workspace
  • POSTgrant a private, non-custom sourceDefinition to a given workspace/v1/source_definitions/grant_definition
  • POSTList all the sourceDefinitions the current Airbyte deployment is configured to use/v1/source_definitions/list
  • POSTList all the sourceDefinitions the given workspace is configured to use/v1/source_definitions/list_for_workspace
  • POSTList the latest sourceDefinitions Airbyte supports/v1/source_definitions/list_latestGuaranteed to retrieve the latest information on supported sources.
  • POSTList all private, non-custom sourceDefinitions, and for each indicate whether the given workspace has a grant for using the definition. Used by admins to view and modify a given workspace's grants./v1/source_definitions/list_private
  • POSTrevoke a grant to a private, non-custom sourceDefinition from a given workspace/v1/source_definitions/revoke_definition
  • POSTUpdate a sourceDefinition/v1/source_definitions/update

source_definition_specification

  • POSTGet specification for a SourceDefinition./v1/source_definition_specifications/get

source

  • POSTCheck connection to the source/v1/sources/check_connection
  • POSTCheck connection for a proposed update to a source/v1/sources/check_connection_for_update
  • POSTClone source/v1/sources/clone
  • POSTCreate a source/v1/sources/create
  • POSTDelete a source/v1/sources/delete
  • POSTDiscover the schema catalog of the source/v1/sources/discover_schema
  • POSTGet source/v1/sources/get
  • POSTList sources for workspace/v1/sources/listList sources for workspace. Does not return deleted sources.
  • POSTGet most recent ActorCatalog for source/v1/sources/most_recent_source_actor_catalog
  • POSTSearch sources/v1/sources/search
  • POSTUpdate a source/v1/sources/update
  • POSTShould only called from worker, to write result from discover activity back to DB./v1/sources/write_discover_catalog_result

destination_definition

  • POSTCreates a custom destinationDefinition for the given workspace/v1/destination_definitions/create_custom
  • POSTDelete a destination definition/v1/destination_definitions/delete
  • POSTGet destinationDefinition/v1/destination_definitions/get
  • POSTGet a destinationDefinition that is configured for the given workspace/v1/destination_definitions/get_for_workspace
  • POSTgrant a private, non-custom destinationDefinition to a given workspace/v1/destination_definitions/grant_definition
  • POSTList all the destinationDefinitions the current Airbyte deployment is configured to use/v1/destination_definitions/list
  • POSTList all the destinationDefinitions the given workspace is configured to use/v1/destination_definitions/list_for_workspace
  • POSTList the latest destinationDefinitions Airbyte supports/v1/destination_definitions/list_latestGuaranteed to retrieve the latest information on supported destinations.
  • POSTList all private, non-custom destinationDefinitions, and for each indicate whether the given workspace has a grant for using the definition. Used by admins to view and modify a given workspace's grants./v1/destination_definitions/list_private
  • POSTrevoke a grant to a private, non-custom destinationDefinition from a given workspace/v1/destination_definitions/revoke_definition
  • POSTUpdate destinationDefinition/v1/destination_definitions/update

destination_definition_specification

  • POSTGet specification for a destinationDefinition/v1/destination_definition_specifications/get

destination

  • POSTCheck connection to the destination/v1/destinations/check_connection
  • POSTCheck connection for a proposed update to a destination/v1/destinations/check_connection_for_update
  • POSTClone destination/v1/destinations/clone
  • POSTCreate a destination/v1/destinations/create
  • POSTDelete the destination/v1/destinations/delete
  • POSTGet configured destination/v1/destinations/get
  • POSTList configured destinations for a workspace/v1/destinations/list
  • POSTSearch destinations/v1/destinations/search
  • POSTUpdate a destination/v1/destinations/update

connection

  • POSTCreate a connection between a source and a destination/v1/connections/create
  • POSTDelete a connection/v1/connections/delete
  • POSTGet a connection/v1/connections/get
  • POSTReturns all connections for a workspace./v1/connections/listList connections for workspace. Does not return deleted connections.
  • POSTReturns all connections for a workspace, including deleted connections./v1/connections/list_allList connections for workspace, including deleted connections.
  • POSTReset the data for the connection. Deletes data generated by the connection in the destination. Resets any cursors back to initial state./v1/connections/reset
  • POSTSearch connections/v1/connections/search
  • POSTTrigger a manual sync of the connection/v1/connections/sync
  • POSTUpdate a connection/v1/connections/updateApply a patch-style update to a connection. Only fields present on the update request body will be updated. Note that if a catalog is present in the request…

destination_oauth

  • POSTGiven a destination def ID generate an access/refresh token etc./v1/destination_oauths/complete_oauth
  • POSTGiven a destination connector definition ID, return the URL to the consent screen where to redirect the user to./v1/destination_oauths/get_consent_url
  • POSTSets instancewide variables to be used for the oauth flow when creating this destination. When set, these variables will be injected into a connector's configuration before any interaction with the connector image itself. This enables running oauth flows with consistent variables e.g: the company's Google Ads developer_token, client_id, and client_secret without the user having to know about these variables. /v1/destination_oauths/oauth_params/create

source_oauth

  • POSTGiven a source def ID generate an access/refresh token etc./v1/source_oauths/complete_oauth
  • POSTGiven a source connector definition ID, return the URL to the consent screen where to redirect the user to./v1/source_oauths/get_consent_url
  • POSTSets instancewide variables to be used for the oauth flow when creating this source. When set, these variables will be injected into a connector's configuration before any interaction with the connector image itself. This enables running oauth flows with consistent variables e.g: the company's Google Ads developer_token, client_id, and client_secret without the user having to know about these variables. /v1/source_oauths/oauth_params/create

web_backend

  • POSTReturns a summary of source and destination definitions that could be updated./v1/web_backend/check_updates
  • POSTCreate a connection/v1/web_backend/connections/create
  • POSTGet a connection/v1/web_backend/connections/get
  • POSTReturns all non-deleted connections for a workspace./v1/web_backend/connections/list
  • POSTUpdate a connection/v1/web_backend/connections/updateApply a patch-style update to a connection. Only fields present on the update request body will be updated. Any operations that lack an ID will be created.…
  • POSTReturns available geographies can be selected to run data syncs in a particular geography. The 'auto' entry indicates that the sync will be automatically assigned to a geography according to the platform default behavior. Entries other than 'auto' are two-letter country codes that follow the ISO 3166-1 alpha-2 standard. /v1/web_backend/geographies/listReturns all available geographies in which a data sync can run.
  • POSTFetch the current state type for a connection./v1/web_backend/state/get_type
  • POSTReturns the current state of a workspace/v1/web_backend/workspace/state

health

  • GETHealth Check/v1/health

attempt

  • POSTFor worker to set sync stats of a running attempt./v1/attempt/save_stats
  • POSTFor worker to save the AttemptSyncConfig for an attempt./v1/attempt/save_sync_config
  • POSTFor worker to register the workflow id in attempt./v1/attempt/set_workflow_in_attempt

state

  • POSTCreate or update the state for a connection./v1/state/create_or_update
  • POSTFetch the current state for a connection./v1/state/get

jobs

  • POSTCancels a job/v1/jobs/cancel
  • POSTGet information about a job/v1/jobs/get
  • POSTGets all information needed to debug this job/v1/jobs/get_debug_info
  • POSTgetLastReplicationJob/v1/jobs/get_last_replication_job
  • POSTGet information about a job excluding attempt info and logs/v1/jobs/get_light
  • POSTGet normalization status to determine if we can bypass normalization phase/v1/jobs/get_normalization_status
  • POSTReturns recent jobs for a connection. Jobs are returned in descending order by createdAt./v1/jobs/list

logs

  • POSTGet logs/v1/logs/get

notifications

  • POSTTry sending a notifications/v1/notifications/try

openapi

  • GETReturns the openapi specification/v1/openapi

operation

  • POSTCheck if an operation to be created is valid/v1/operations/check
  • POSTCreate an operation to be applied as part of a connection pipeline/v1/operations/create
  • POSTDelete an operation/v1/operations/delete
  • POSTReturns an operation/v1/operations/get
  • POSTReturns all operations for a connection./v1/operations/listList operations for connection.
  • POSTUpdate an operation/v1/operations/update

scheduler

  • POSTRun check connection for a given destination configuration/v1/scheduler/destinations/check_connection
  • POSTRun check connection for a given source configuration/v1/scheduler/sources/check_connection
  • POSTRun discover schema for a given source a source configuration/v1/scheduler/sources/discover_schema

API details

Base URL
http://airbyte.local
http://localhost:8000/api
Authentication
A bearer token in the Authorization header
Operations
102 operations on 102 pathsPOST 100GET 2
Main resources
source 12destination_definition 11source_definition 11connection 9destination 9workspace 9web_backend 8jobs 7internal 6operation 6
Response formats
application/json text/plain
Description format
OpenAPI 3.0.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Airbyte Configuration API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Airbyte Configuration API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Creates a workspace” (POST /v1/workspaces/create), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Airbyte Configuration API?

Airbyte Configuration API [https://airbyte.io](https://airbyte.io). This API is a collection of HTTP RPC-style methods. While it is not a REST API, those… It is listed under Developer tools and has 102 endpoints.

Who publishes the Airbyte Configuration API?

It is listed from Airbyte's public API description (an OpenAPI document), not published by Airbyte on Swastik Codes. Anyone who controls airbyte.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Airbyte Configuration API?

Its description lists 2 base URLs: http://airbyte.local, http://localhost:8000/api. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Airbyte Configuration API?

With A bearer token in the Authorization header.

How many endpoints does the Airbyte Configuration API have?

102 operations on 102 paths (100 POST, 2 GET). The largest groups are source, destination_definition, source_definition, connection.

Is forking the Airbyte Configuration API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.