APIHub
Back to Explore

Airbyte Configuration API

Airbyte Configuration API [https://airbyte.io](https://airbyte.io).

Development
bearer
No HTTPS
CORS: Unknown
Visit official documentation

Latency

2840ms p95

Uptime

0.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
POST

/v1/jobs/get_light

Get information about a job excluding attempt info and logs

POST

/v1/jobs/get_normalization_status

Get normalization status to determine if we can bypass normalization phase

POST

/v1/web_backend/connections/get

Get a connection

POST

/v1/jobs/list

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

POST

/v1/logs/get

Get logs

POST

/v1/notifications/try

Try sending a notifications

GET

/v1/openapi

Returns the openapi specification

POST

/v1/operations/check

Check if an operation to be created is valid

POST

/v1/destination_oauths/oauth_params/create

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

/v1/destinations/check_connection

Check connection to the destination

POST

/v1/destinations/check_connection_for_update

Check connection for a proposed update to a destination

POST

/v1/destinations/clone

Clone destination

POST

/v1/destinations/create

Create a destination

POST

/v1/destinations/delete

Delete the destination

POST

/v1/destinations/get

Get configured destination

POST

/v1/destinations/list

List configured destinations for a workspace

POST

/v1/destinations/search

Search destinations

POST

/v1/destinations/update

Update a destination

GET

/v1/health

Health Check

POST

/v1/jobs/cancel

Cancels a job

POST

/v1/jobs/get

Get information about a job

POST

/v1/attempt/save_stats

For worker to set sync stats of a running attempt.

POST

/v1/attempt/save_sync_config

For worker to save the AttemptSyncConfig for an attempt.

POST

/v1/attempt/set_workflow_in_attempt

For worker to register the workflow id in attempt.

POST

/v1/connections/create

Create a connection between a source and a destination

POST

/v1/connections/delete

Delete a connection

POST

/v1/connections/get

Get a connection

POST

/v1/connections/list

Returns all connections for a workspace.

POST

/v1/connections/list_all

Returns all connections for a workspace, including deleted connections.

POST

/v1/connections/reset

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

POST

/v1/connections/search

Search connections

POST

/v1/connections/sync

Trigger a manual sync of the connection

POST

/v1/connections/update

Update a connection

POST

/v1/destination_definition_specifications/get

Get specification for a destinationDefinition

POST

/v1/destination_definitions/create_custom

Creates a custom destinationDefinition for the given workspace

POST

/v1/destination_definitions/delete

Delete a destination definition

POST

/v1/destination_definitions/get

Get destinationDefinition

POST

/v1/destination_definitions/get_for_workspace

Get a destinationDefinition that is configured for the given workspace

POST

/v1/destination_definitions/grant_definition

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

POST

/v1/destination_definitions/list

List all the destinationDefinitions the current Airbyte deployment is configured to use

POST

/v1/destination_definitions/list_for_workspace

List all the destinationDefinitions the given workspace is configured to use

POST

/v1/destination_definitions/list_latest

List the latest destinationDefinitions Airbyte supports

POST

/v1/destination_definitions/list_private

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

/v1/destination_definitions/revoke_definition

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

POST

/v1/destination_definitions/update

Update destinationDefinition

POST

/v1/destination_oauths/complete_oauth

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

POST

/v1/destination_oauths/get_consent_url

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

POST

/v1/jobs/get_debug_info

Gets all information needed to debug this job

POST

/v1/jobs/get_last_replication_job

POST

/v1/operations/create

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

POST

/v1/operations/delete

Delete an operation

POST

/v1/operations/get

Returns an operation

POST

/v1/operations/list

Returns all operations for a connection.

POST

/v1/operations/update

Update an operation

POST

/v1/scheduler/destinations/check_connection

Run check connection for a given destination configuration

POST

/v1/scheduler/sources/check_connection

Run check connection for a given source configuration

POST

/v1/scheduler/sources/discover_schema

Run discover schema for a given source a source configuration

POST

/v1/source_definition_specifications/get

Get specification for a SourceDefinition.

POST

/v1/source_definitions/create_custom

Creates a custom sourceDefinition for the given workspace

POST

/v1/source_definitions/delete

Delete a source definition

POST

/v1/source_definitions/get

Get source

POST

/v1/source_definitions/get_for_workspace

Get a sourceDefinition that is configured for the given workspace

POST

/v1/source_definitions/grant_definition

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

POST

/v1/source_definitions/list

List all the sourceDefinitions the current Airbyte deployment is configured to use

POST

/v1/source_definitions/list_for_workspace

List all the sourceDefinitions the given workspace is configured to use

POST

/v1/source_definitions/list_latest

List the latest sourceDefinitions Airbyte supports

POST

/v1/source_definitions/list_private

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

/v1/source_definitions/revoke_definition

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

POST

/v1/source_definitions/update

Update a sourceDefinition

POST

/v1/source_oauths/complete_oauth

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

POST

/v1/source_oauths/get_consent_url

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

POST

/v1/source_oauths/oauth_params/create

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

/v1/sources/check_connection

Check connection to the source

POST

/v1/sources/check_connection_for_update

Check connection for a proposed update to a source

POST

/v1/sources/clone

Clone source

POST

/v1/sources/create

Create a source

POST

/v1/sources/delete

Delete a source

POST

/v1/sources/discover_schema

Discover the schema catalog of the source

POST

/v1/sources/get

Get source

POST

/v1/sources/list

List sources for workspace

POST

/v1/sources/most_recent_source_actor_catalog

Get most recent ActorCatalog for source

POST

/v1/sources/search

Search sources

POST

/v1/sources/update

Update a source

POST

/v1/sources/write_discover_catalog_result

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

POST

/v1/state/create_or_update

Create or update the state for a connection.

POST

/v1/state/get

Fetch the current state for a connection.

POST

/v1/web_backend/check_updates

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

POST

/v1/web_backend/connections/create

Create a connection

POST

/v1/web_backend/connections/list

Returns all non-deleted connections for a workspace.

POST

/v1/web_backend/connections/update

Update a connection

POST

/v1/web_backend/geographies/list

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

/v1/web_backend/state/get_type

Fetch the current state type for a connection.

POST

/v1/web_backend/workspace/state

Returns the current state of a workspace

POST

/v1/workspaces/create

Creates a workspace

POST

/v1/workspaces/delete

Deletes a workspace

POST

/v1/workspaces/get

Find workspace by ID

POST

/v1/workspaces/get_by_connection_id

Find workspace by connection id

POST

/v1/workspaces/get_by_slug

Find workspace by slug

POST

/v1/workspaces/list

List all workspaces registered in the current Airbyte deployment

POST

/v1/workspaces/tag_feedback_status_as_done

Update workspace feedback state

POST

/v1/workspaces/update

Update workspace state

POST

/v1/workspaces/update_name

Update workspace name

102 endpoints auto-detected

Authentication

This API uses Bearer token authentication — pass your token in the Authorization header.

curl -X POST \
  "http://airbyte.local/v1/jobs/get_light" \
  -H "Authorization: Bearer YOUR_TOKEN"

airbyte.local · HTTPS only