airbyte.local – config

OpenAPI apis-guru developer_tools

Airbyte Configuration API .

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=="

Homepage: https://api.apis.guru/v2/specs/airbyte.local:config/1.0.0.json
Provider: airbyte.local:config / config
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/openapi.yaml

Tools (104)

Extracted live via the executor SDK.

attempt.saveStats

For worker to set sync stats of a running attempt.
attempt.saveSyncConfig

For worker to save the AttemptSyncConfig for an attempt.
attempt.setWorkflowInAttempt

For worker to register the workflow id in attempt.
connection.createConnection

Create a connection between a source and a destination
connection.deleteConnection

Delete a connection
connection.getConnection

Get a connection
connection.listAllConnectionsForWorkspace

List connections for workspace, including deleted connections.
connection.listConnectionsForWorkspace

List connections for workspace. Does not return deleted connections.
connection.resetConnection

Reset the data for the connection. Deletes data generated by the connection in the destination. Resets any cursors back to initial state.
connection.searchConnections

Search connections
connection.syncConnection

Trigger a manual sync of the connection
connection.updateConnection

Apply 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 body, the connection's entire catalog will be replaced with the catalog from the request. This means that to modify a single stream, the entire new catalog containing the updated stream needs to be sent.
destination.checkConnectionToDestination

Check connection to the destination
destination.checkConnectionToDestinationForUpdate

Check connection for a proposed update to a destination
destination.cloneDestination

Clone destination
destination.createDestination

Create a destination
destination.deleteDestination

Delete the destination
destination.getDestination

Get configured destination
destination.listDestinationsForWorkspace

List configured destinations for a workspace
destination.searchDestinations

Search destinations
destination.updateDestination

Update a destination
destinationDefinition.createCustomDestinationDefinition

Creates a custom destinationDefinition for the given workspace
destinationDefinition.deleteDestinationDefinition

Delete a destination definition
destinationDefinition.getDestinationDefinition

Get destinationDefinition
destinationDefinition.getDestinationDefinitionForWorkspace

Get a destinationDefinition that is configured for the given workspace
destinationDefinition.grantDestinationDefinitionToWorkspace

grant a private, non-custom destinationDefinition to a given workspace
destinationDefinition.listDestinationDefinitions

List all the destinationDefinitions the current Airbyte deployment is configured to use
destinationDefinition.listDestinationDefinitionsForWorkspace

List all the destinationDefinitions the given workspace is configured to use
destinationDefinition.listLatestDestinationDefinitions

Guaranteed to retrieve the latest information on supported destinations.
destinationDefinition.listPrivateDestinationDefinitions

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.
destinationDefinition.revokeDestinationDefinitionFromWorkspace

revoke a grant to a private, non-custom destinationDefinition from a given workspace
destinationDefinition.updateDestinationDefinition

Update destinationDefinition
destinationDefinitionSpecification.getDestinationDefinitionSpecification

Get specification for a destinationDefinition
destinationOauth.completeDestinationOAuth

Given a destination def ID generate an access/refresh token etc.
destinationOauth.getDestinationOAuthConsent

Given a destination connector definition ID, return the URL to the consent screen where to redirect the user to.
destinationOauth.setInstancewideDestinationOauthParams

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.
health.getHealthCheck

Health Check
jobs.cancelJob

Cancels a job
jobs.getAttemptNormalizationStatusesForJob

Get normalization status to determine if we can bypass normalization phase
jobs.getJobDebugInfo

Gets all information needed to debug this job
jobs.getJobInfo

Get information about a job
jobs.getJobInfoLight

Get information about a job excluding attempt info and logs
jobs.getLastReplicationJob

POST /v1/jobs/get_last_replication_job
jobs.listJobsFor

Returns recent jobs for a connection. Jobs are returned in descending order by createdAt.
logs.getLogs

Get logs
notifications.tryNotificationConfig

Try sending a notifications
openapi.getOpenApiSpec

Returns the openapi specification
operation.checkOperation

Check if an operation to be created is valid
operation.createOperation

Create an operation to be applied as part of a connection pipeline
operation.deleteOperation

Delete an operation
operation.getOperation

Returns an operation
operation.listOperationsForConnection

List operations for connection.
operation.updateOperation

Update an operation
scheduler.executeDestinationCheckConnection

Run check connection for a given destination configuration
scheduler.executeSourceCheckConnection

Run check connection for a given source configuration
scheduler.executeSourceDiscoverSchema

Run discover schema for a given source a source configuration
source.checkConnectionToSource

Check connection to the source
source.checkConnectionToSourceForUpdate

Check connection for a proposed update to a source
source.cloneSource

Clone source
source.createSource

Create a source
source.deleteSource

Delete a source
source.discoverSchemaForSource

Discover the schema catalog of the source
source.getMostRecentSourceActorCatalog

Get most recent ActorCatalog for source
source.getSource

Get source
source.listSourcesForWorkspace

List sources for workspace. Does not return deleted sources.
source.searchSources

Search sources
source.updateSource

Update a source
source.writeDiscoverCatalogResult

Should only called from worker, to write result from discover activity back to DB.
sourceDefinition.createCustomSourceDefinition

Creates a custom sourceDefinition for the given workspace
sourceDefinition.deleteSourceDefinition

Delete a source definition
sourceDefinition.getSourceDefinition

Get source
sourceDefinition.getSourceDefinitionForWorkspace

Get a sourceDefinition that is configured for the given workspace
sourceDefinition.grantSourceDefinitionToWorkspace

grant a private, non-custom sourceDefinition to a given workspace
sourceDefinition.listLatestSourceDefinitions

Guaranteed to retrieve the latest information on supported sources.
sourceDefinition.listPrivateSourceDefinitions

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.
sourceDefinition.listSourceDefinitions

List all the sourceDefinitions the current Airbyte deployment is configured to use
sourceDefinition.listSourceDefinitionsForWorkspace

List all the sourceDefinitions the given workspace is configured to use
sourceDefinition.revokeSourceDefinitionFromWorkspace

revoke a grant to a private, non-custom sourceDefinition from a given workspace
sourceDefinition.updateSourceDefinition

Update a sourceDefinition
sourceDefinitionSpecification.getSourceDefinitionSpecification

Get specification for a SourceDefinition.
sourceOauth.completeSourceOAuth

Given a source def ID generate an access/refresh token etc.
sourceOauth.getSourceOAuthConsent

Given a source connector definition ID, return the URL to the consent screen where to redirect the user to.
sourceOauth.setInstancewideSourceOauthParams

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.
state.createOrUpdateState

Create or update the state for a connection.
state.getState

Fetch the current state for a connection.
webBackend.getStateType

Fetch the current state type for a connection.
webBackend.webBackendCheckUpdates

Returns a summary of source and destination definitions that could be updated.
webBackend.webBackendCreateConnection

Create a connection
webBackend.webBackendGetConnection

Get a connection
webBackend.webBackendGetWorkspaceState

Returns the current state of a workspace
webBackend.webBackendListConnectionsForWorkspace

Returns all non-deleted connections for a workspace.
webBackend.webBackendListGeographies

Returns all available geographies in which a data sync can run.
webBackend.webBackendUpdateConnection

Apply 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. Then, the newly created operationId will be applied to the connection along with the rest of the operationIds in the request body. Apply 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 body, the connection's entire catalog will be replaced with the catalog from the request. This means that to modify a single stream, the entire new catalog containing the updated stream needs to be sent.
workspace.createWorkspace

Creates a workspace
workspace.deleteWorkspace

Deletes a workspace
workspace.getWorkspace

Find workspace by ID
workspace.getWorkspaceByConnectionId

Find workspace by connection id
workspace.getWorkspaceBySlug

Find workspace by slug
workspace.listWorkspaces

List all workspaces registered in the current Airbyte deployment
workspace.updateWorkspace

Update workspace state
workspace.updateWorkspaceFeedback

Update workspace feedback state
workspace.updateWorkspaceName

Update workspace name
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools