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 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==`)
http://airbyte.local102 endpoints available
/v1/healthHealth Check
/v1/openapiReturns the openapi specification
/v1/jobs/getGet information about a job
/v1/logs/getGet logs
/v1/jobs/listReturns recent jobs for a connection. Jobs are returned in descending order by createdAt.
/v1/state/getFetch the current state for a connection.
/v1/jobs/cancelCancels a job
/v1/sources/getGet source
/v1/sources/listList sources for workspace
/v1/sources/cloneClone source
/v1/jobs/get_lightGet information about a job excluding attempt info and logs
/v1/operations/getReturns an operation
/v1/sources/createCreate a source
/v1/sources/deleteDelete a source
/v1/sources/searchSearch sources
/v1/sources/updateUpdate a source
/v1/workspaces/getFind workspace by ID
/v1/connections/getGet a connection
/v1/operations/listReturns all operations for a connection.
/v1/workspaces/listList all workspaces registered in the current Airbyte deployment
/v1/connections/listReturns all connections for a workspace.
/v1/connections/syncTrigger a manual sync of the connection
/v1/destinations/getGet configured destination
/v1/operations/checkCheck if an operation to be created is valid
/v1/connections/resetReset the data for the connection. Deletes data generated by the connection in the destination. Resets any cursors back to initial state.
/v1/destinations/listList configured destinations for a workspace
/v1/notifications/tryTry sending a notifications
/v1/operations/createCreate an operation to be applied as part of a connection pipeline
/v1/operations/deleteDelete an operation
/v1/operations/updateUpdate an operation
/v1/workspaces/createCreates a workspace
/v1/workspaces/deleteDeletes a workspace
/v1/workspaces/updateUpdate workspace state
/v1/attempt/save_statsFor worker to set sync stats of a running attempt.
/v1/connections/createCreate a connection between a source and a destination
/v1/connections/deleteDelete a connection
/v1/connections/searchSearch connections
/v1/connections/updateUpdate a connection
/v1/destinations/cloneClone destination
/v1/destinations/createCreate a destination
/v1/destinations/deleteDelete the destination
/v1/destinations/searchSearch destinations
/v1/destinations/updateUpdate a destination
/v1/jobs/get_debug_infoGets all information needed to debug this job
/v1/connections/list_allReturns all connections for a workspace, including deleted connections.
/v1/source_definitions/getGet source
/v1/state/create_or_updateCreate or update the state for a connection.
/v1/workspaces/get_by_slugFind workspace by slug
/v1/workspaces/update_nameUpdate workspace name
/v1/source_definitions/listList all the sourceDefinitions the current Airbyte deployment is configured to use
/v1/sources/discover_schemaDiscover the schema catalog of the source
/v1/attempt/save_sync_configFor worker to save the AttemptSyncConfig for an attempt.
/v1/sources/check_connectionCheck connection to the source
/v1/source_definitions/deleteDelete a source definition
/v1/source_definitions/updateUpdate a sourceDefinition
/v1/web_backend/check_updatesReturns a summary of source and destination definitions that could be updated.
/v1/web_backend/state/get_typeFetch the current state type for a connection.
/v1/destination_definitions/getGet destinationDefinition
/v1/web_backend/connections/getGet a connection
/v1/web_backend/workspace/stateReturns the current state of a workspace
/v1/destination_definitions/listList all the destinationDefinitions the current Airbyte deployment is configured to use
/v1/source_oauths/complete_oauthGiven a source def ID generate an access/refresh token etc.
/v1/web_backend/connections/listReturns all non-deleted connections for a workspace.
/v1/web_backend/geographies/listReturns 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/destinations/check_connectionCheck connection to the destination
/v1/jobs/get_last_replication_job/v1/jobs/get_normalization_statusGet normalization status to determine if we can bypass normalization phase
/v1/source_oauths/get_consent_urlGiven a source connector definition ID, return the URL to the consent screen where to redirect the user to.
/v1/destination_definitions/deleteDelete a destination definition
/v1/destination_definitions/updateUpdate destinationDefinition
/v1/source_definitions/list_latestList the latest sourceDefinitions Airbyte supports
/v1/web_backend/connections/createCreate a connection
/v1/web_backend/connections/updateUpdate a connection
/v1/attempt/set_workflow_in_attemptFor worker to register the workflow id in attempt.
/v1/source_definitions/list_privateList 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/workspaces/get_by_connection_idFind workspace by connection id
/v1/source_definitions/create_customCreates a custom sourceDefinition for the given workspace
/v1/destination_oauths/complete_oauthGiven a destination def ID generate an access/refresh token etc.
/v1/scheduler/sources/discover_schemaRun discover schema for a given source a source configuration
/v1/source_oauths/oauth_params/createSets 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/destination_oauths/get_consent_urlGiven a destination connector definition ID, return the URL to the consent screen where to redirect the user to.
/v1/scheduler/sources/check_connectionRun check connection for a given source configuration
/v1/destination_definitions/list_latestList the latest destinationDefinitions Airbyte supports
/v1/source_definitions/grant_definitiongrant a private, non-custom sourceDefinition to a given workspace
/v1/sources/check_connection_for_updateCheck connection for a proposed update to a source
/v1/destination_definitions/list_privateList 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/source_definition_specifications/getGet specification for a SourceDefinition.
/v1/source_definitions/get_for_workspaceGet a sourceDefinition that is configured for the given workspace
/v1/source_definitions/revoke_definitionrevoke a grant to a private, non-custom sourceDefinition from a given workspace
/v1/destination_definitions/create_customCreates a custom destinationDefinition for the given workspace
/v1/source_definitions/list_for_workspaceList all the sourceDefinitions the given workspace is configured to use
/v1/sources/write_discover_catalog_resultShould only called from worker, to write result from discover activity back to DB.
/v1/destination_oauths/oauth_params/createSets 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/workspaces/tag_feedback_status_as_doneUpdate workspace feedback state
/v1/scheduler/destinations/check_connectionRun check connection for a given destination configuration
/v1/destination_definitions/grant_definitiongrant a private, non-custom destinationDefinition to a given workspace
/v1/destinations/check_connection_for_updateCheck connection for a proposed update to a destination
/v1/sources/most_recent_source_actor_catalogGet most recent ActorCatalog for source
/v1/destination_definition_specifications/getGet specification for a destinationDefinition
/v1/destination_definitions/get_for_workspaceGet a destinationDefinition that is configured for the given workspace
/v1/destination_definitions/revoke_definitionrevoke a grant to a private, non-custom destinationDefinition from a given workspace
/v1/destination_definitions/list_for_workspaceList all the destinationDefinitions the given workspace is configured to use
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 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==`)
http://airbyte.local102 endpoints available
/v1/healthHealth Check
/v1/openapiReturns the openapi specification
/v1/jobs/getGet information about a job
/v1/logs/getGet logs
/v1/jobs/listReturns recent jobs for a connection. Jobs are returned in descending order by createdAt.
/v1/state/getFetch the current state for a connection.
/v1/jobs/cancelCancels a job
/v1/sources/getGet source
/v1/sources/listList sources for workspace
/v1/sources/cloneClone source
/v1/jobs/get_lightGet information about a job excluding attempt info and logs
/v1/operations/getReturns an operation
/v1/sources/createCreate a source
/v1/sources/deleteDelete a source
/v1/sources/searchSearch sources
/v1/sources/updateUpdate a source
/v1/workspaces/getFind workspace by ID
/v1/connections/getGet a connection
/v1/operations/listReturns all operations for a connection.
/v1/workspaces/listList all workspaces registered in the current Airbyte deployment
/v1/connections/listReturns all connections for a workspace.
/v1/connections/syncTrigger a manual sync of the connection
/v1/destinations/getGet configured destination
/v1/operations/checkCheck if an operation to be created is valid
/v1/connections/resetReset the data for the connection. Deletes data generated by the connection in the destination. Resets any cursors back to initial state.
/v1/destinations/listList configured destinations for a workspace
/v1/notifications/tryTry sending a notifications
/v1/operations/createCreate an operation to be applied as part of a connection pipeline
/v1/operations/deleteDelete an operation
/v1/operations/updateUpdate an operation
/v1/workspaces/createCreates a workspace
/v1/workspaces/deleteDeletes a workspace
/v1/workspaces/updateUpdate workspace state
/v1/attempt/save_statsFor worker to set sync stats of a running attempt.
/v1/connections/createCreate a connection between a source and a destination
/v1/connections/deleteDelete a connection
/v1/connections/searchSearch connections
/v1/connections/updateUpdate a connection
/v1/destinations/cloneClone destination
/v1/destinations/createCreate a destination
/v1/destinations/deleteDelete the destination
/v1/destinations/searchSearch destinations
/v1/destinations/updateUpdate a destination
/v1/jobs/get_debug_infoGets all information needed to debug this job
/v1/connections/list_allReturns all connections for a workspace, including deleted connections.
/v1/source_definitions/getGet source
/v1/state/create_or_updateCreate or update the state for a connection.
/v1/workspaces/get_by_slugFind workspace by slug
/v1/workspaces/update_nameUpdate workspace name
/v1/source_definitions/listList all the sourceDefinitions the current Airbyte deployment is configured to use
/v1/sources/discover_schemaDiscover the schema catalog of the source
/v1/attempt/save_sync_configFor worker to save the AttemptSyncConfig for an attempt.
/v1/sources/check_connectionCheck connection to the source
/v1/source_definitions/deleteDelete a source definition
/v1/source_definitions/updateUpdate a sourceDefinition
/v1/web_backend/check_updatesReturns a summary of source and destination definitions that could be updated.
/v1/web_backend/state/get_typeFetch the current state type for a connection.
/v1/destination_definitions/getGet destinationDefinition
/v1/web_backend/connections/getGet a connection
/v1/web_backend/workspace/stateReturns the current state of a workspace
/v1/destination_definitions/listList all the destinationDefinitions the current Airbyte deployment is configured to use
/v1/source_oauths/complete_oauthGiven a source def ID generate an access/refresh token etc.
/v1/web_backend/connections/listReturns all non-deleted connections for a workspace.
/v1/web_backend/geographies/listReturns 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/destinations/check_connectionCheck connection to the destination
/v1/jobs/get_last_replication_job/v1/jobs/get_normalization_statusGet normalization status to determine if we can bypass normalization phase
/v1/source_oauths/get_consent_urlGiven a source connector definition ID, return the URL to the consent screen where to redirect the user to.
/v1/destination_definitions/deleteDelete a destination definition
/v1/destination_definitions/updateUpdate destinationDefinition
/v1/source_definitions/list_latestList the latest sourceDefinitions Airbyte supports
/v1/web_backend/connections/createCreate a connection
/v1/web_backend/connections/updateUpdate a connection
/v1/attempt/set_workflow_in_attemptFor worker to register the workflow id in attempt.
/v1/source_definitions/list_privateList 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/workspaces/get_by_connection_idFind workspace by connection id
/v1/source_definitions/create_customCreates a custom sourceDefinition for the given workspace
/v1/destination_oauths/complete_oauthGiven a destination def ID generate an access/refresh token etc.
/v1/scheduler/sources/discover_schemaRun discover schema for a given source a source configuration
/v1/source_oauths/oauth_params/createSets 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/destination_oauths/get_consent_urlGiven a destination connector definition ID, return the URL to the consent screen where to redirect the user to.
/v1/scheduler/sources/check_connectionRun check connection for a given source configuration
/v1/destination_definitions/list_latestList the latest destinationDefinitions Airbyte supports
/v1/source_definitions/grant_definitiongrant a private, non-custom sourceDefinition to a given workspace
/v1/sources/check_connection_for_updateCheck connection for a proposed update to a source
/v1/destination_definitions/list_privateList 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/source_definition_specifications/getGet specification for a SourceDefinition.
/v1/source_definitions/get_for_workspaceGet a sourceDefinition that is configured for the given workspace
/v1/source_definitions/revoke_definitionrevoke a grant to a private, non-custom sourceDefinition from a given workspace
/v1/destination_definitions/create_customCreates a custom destinationDefinition for the given workspace
/v1/source_definitions/list_for_workspaceList all the sourceDefinitions the given workspace is configured to use
/v1/sources/write_discover_catalog_resultShould only called from worker, to write result from discover activity back to DB.
/v1/destination_oauths/oauth_params/createSets 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/workspaces/tag_feedback_status_as_doneUpdate workspace feedback state
/v1/scheduler/destinations/check_connectionRun check connection for a given destination configuration
/v1/destination_definitions/grant_definitiongrant a private, non-custom destinationDefinition to a given workspace
/v1/destinations/check_connection_for_updateCheck connection for a proposed update to a destination
/v1/sources/most_recent_source_actor_catalogGet most recent ActorCatalog for source
/v1/destination_definition_specifications/getGet specification for a destinationDefinition
/v1/destination_definitions/get_for_workspaceGet a destinationDefinition that is configured for the given workspace
/v1/destination_definitions/revoke_definitionrevoke a grant to a private, non-custom destinationDefinition from a given workspace
/v1/destination_definitions/list_for_workspaceList all the destinationDefinitions the given workspace is configured to use