Own Airbyte? Customize your docs with AI search, analytics, and more.

Claim your docs

Airbyte Configuration API

Airbyte

Powered by Specway

Own Airbyte? Customize your docs with AI search, analytics, and more.

Claim your docs

Airbyte Configuration API

Airbyte

Powered by Specway

Endpoints

For worker to register the workflow id in attempt.POST
For worker to save the AttemptSyncConfig for an attempt.POST
For worker to set sync stats of a running attempt.POST

Create a connection between a source and a destinationPOST
Delete a connectionPOST
Get a connectionPOST
Reset the data for the connection. Deletes data generated by the connection in the destination. Resets any cursors back to initial state.POST
Returns all connections for a workspace, including deleted connections.POST
Returns all connections for a workspace.POST
Search connectionsPOST
Trigger a manual sync of the connectionPOST
Update a connectionPOST

Get specification for a destinationDefinitionPOST

Creates a custom destinationDefinition for the given workspacePOST
Delete a destination definitionPOST
Get a destinationDefinition that is configured for the given workspacePOST
Get destinationDefinitionPOST
grant a private, non-custom destinationDefinition to a given workspacePOST
List 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.POST
List all the destinationDefinitions the current Airbyte deployment is configured to usePOST
List all the destinationDefinitions the given workspace is configured to usePOST
List the latest destinationDefinitions Airbyte supportsPOST
revoke a grant to a private, non-custom destinationDefinition from a given workspacePOST
Update destinationDefinitionPOST

Given a destination connector definition ID, return the URL to the consent screen where to redirect the user to.POST
Given a destination def ID generate an access/refresh token etc.POST
Sets 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. POST

Check connection for a proposed update to a destinationPOST
Check connection to the destinationPOST
Clone destinationPOST
Create a destinationPOST
Delete the destinationPOST
Get configured destinationPOST
List configured destinations for a workspacePOST
Search destinationsPOST
Update a destinationPOST

Health CheckGET

V1/Jobs/Get Last Replication JobPOST
Cancels a jobPOST
Get information about a jobPOST
Get information about a job excluding attempt info and logsPOST
Get normalization status to determine if we can bypass normalization phasePOST
Gets all information needed to debug this jobPOST
Returns recent jobs for a connection. Jobs are returned in descending order by createdAt.POST

Get logsPOST

Try sending a notificationsPOST

Returns the openapi specificationGET

Check if an operation to be created is validPOST
Create an operation to be applied as part of a connection pipelinePOST
Delete an operationPOST
Returns all operations for a connection.POST
Returns an operationPOST
Update an operationPOST

Run check connection for a given destination configurationPOST
Run check connection for a given source configurationPOST
Run discover schema for a given source a source configurationPOST

Get specification for a SourceDefinition.POST

Creates a custom sourceDefinition for the given workspacePOST
Delete a source definitionPOST
Get a sourceDefinition that is configured for the given workspacePOST
Get sourcePOST
grant a private, non-custom sourceDefinition to a given workspacePOST
List 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.POST
List all the sourceDefinitions the current Airbyte deployment is configured to usePOST
List all the sourceDefinitions the given workspace is configured to usePOST
List the latest sourceDefinitions Airbyte supportsPOST
revoke a grant to a private, non-custom sourceDefinition from a given workspacePOST
Update a sourceDefinitionPOST

Given a source connector definition ID, return the URL to the consent screen where to redirect the user to.POST
Given a source def ID generate an access/refresh token etc.POST
Sets 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. POST

Check connection for a proposed update to a sourcePOST
Check connection to the sourcePOST
Clone sourcePOST
Create a sourcePOST
Delete a sourcePOST
Discover the schema catalog of the sourcePOST
Get most recent ActorCatalog for sourcePOST
Get sourcePOST
List sources for workspacePOST
Search sourcesPOST
Should only called from worker, to write result from discover activity back to DB.POST
Update a sourcePOST

Create or update the state for a connection.POST
Fetch the current state for a connection.POST

Create a connectionPOST
Fetch the current state type for a connection.POST
Get a connectionPOST
Returns a summary of source and destination definitions that could be updated.POST
Returns all non-deleted connections for a workspace.POST
Returns 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. POST
Returns the current state of a workspacePOST
Update a connectionPOST

Creates a workspacePOST
Deletes a workspacePOST
Find workspace by connection idPOST
Find workspace by IDPOST
Find workspace by slugPOST
List all workspaces registered in the current Airbyte deploymentPOST
Update workspace feedback statePOST
Update workspace namePOST
Update workspace statePOST

Endpoints

For worker to register the workflow id in attempt.POST
For worker to save the AttemptSyncConfig for an attempt.POST
For worker to set sync stats of a running attempt.POST

Create a connection between a source and a destinationPOST
Delete a connectionPOST
Get a connectionPOST
Reset the data for the connection. Deletes data generated by the connection in the destination. Resets any cursors back to initial state.POST
Returns all connections for a workspace, including deleted connections.POST
Returns all connections for a workspace.POST
Search connectionsPOST
Trigger a manual sync of the connectionPOST
Update a connectionPOST

Get specification for a destinationDefinitionPOST

Creates a custom destinationDefinition for the given workspacePOST
Delete a destination definitionPOST
Get a destinationDefinition that is configured for the given workspacePOST
Get destinationDefinitionPOST
grant a private, non-custom destinationDefinition to a given workspacePOST
List 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.POST
List all the destinationDefinitions the current Airbyte deployment is configured to usePOST
List all the destinationDefinitions the given workspace is configured to usePOST
List the latest destinationDefinitions Airbyte supportsPOST
revoke a grant to a private, non-custom destinationDefinition from a given workspacePOST
Update destinationDefinitionPOST

Given a destination connector definition ID, return the URL to the consent screen where to redirect the user to.POST
Given a destination def ID generate an access/refresh token etc.POST
Sets 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. POST

Check connection for a proposed update to a destinationPOST
Check connection to the destinationPOST
Clone destinationPOST
Create a destinationPOST
Delete the destinationPOST
Get configured destinationPOST
List configured destinations for a workspacePOST
Search destinationsPOST
Update a destinationPOST

Health CheckGET

V1/Jobs/Get Last Replication JobPOST
Cancels a jobPOST
Get information about a jobPOST
Get information about a job excluding attempt info and logsPOST
Get normalization status to determine if we can bypass normalization phasePOST
Gets all information needed to debug this jobPOST
Returns recent jobs for a connection. Jobs are returned in descending order by createdAt.POST

Get logsPOST

Try sending a notificationsPOST

Returns the openapi specificationGET

Check if an operation to be created is validPOST
Create an operation to be applied as part of a connection pipelinePOST
Delete an operationPOST
Returns all operations for a connection.POST
Returns an operationPOST
Update an operationPOST

Run check connection for a given destination configurationPOST
Run check connection for a given source configurationPOST
Run discover schema for a given source a source configurationPOST

Get specification for a SourceDefinition.POST

Creates a custom sourceDefinition for the given workspacePOST
Delete a source definitionPOST
Get a sourceDefinition that is configured for the given workspacePOST
Get sourcePOST
grant a private, non-custom sourceDefinition to a given workspacePOST
List 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.POST
List all the sourceDefinitions the current Airbyte deployment is configured to usePOST
List all the sourceDefinitions the given workspace is configured to usePOST
List the latest sourceDefinitions Airbyte supportsPOST
revoke a grant to a private, non-custom sourceDefinition from a given workspacePOST
Update a sourceDefinitionPOST

Given a source connector definition ID, return the URL to the consent screen where to redirect the user to.POST
Given a source def ID generate an access/refresh token etc.POST
Sets 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. POST

Check connection for a proposed update to a sourcePOST
Check connection to the sourcePOST
Clone sourcePOST
Create a sourcePOST
Delete a sourcePOST
Discover the schema catalog of the sourcePOST
Get most recent ActorCatalog for sourcePOST
Get sourcePOST
List sources for workspacePOST
Search sourcesPOST
Should only called from worker, to write result from discover activity back to DB.POST
Update a sourcePOST

Create or update the state for a connection.POST
Fetch the current state for a connection.POST

Create a connectionPOST
Fetch the current state type for a connection.POST
Get a connectionPOST
Returns a summary of source and destination definitions that could be updated.POST
Returns all non-deleted connections for a workspace.POST
Returns 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. POST
Returns the current state of a workspacePOST
Update a connectionPOST

Creates a workspacePOST
Deletes a workspacePOST
Find workspace by connection idPOST
Find workspace by IDPOST
Find workspace by slugPOST
List all workspaces registered in the current Airbyte deploymentPOST
Update workspace feedback statePOST
Update workspace namePOST
Update workspace statePOST

Authentication

How to authenticate with the Airbyte Configuration API API.

bearerAuth

http

Authentication

How to authenticate with the Airbyte Configuration API API.

bearerAuth

http