Airbyte Configuration API https://airbyte.io.
The Configuration API is an internal Airbyte API that is designed for communications between different Airbyte components. * Its main purpose is to enable the Airbyte Engineering team to configure the internal state of Airbyte Cloud * It is also sometimes used by OSS users to configure their own Self-Hosted Airbyte deployment (internal state, etc)
WARNING * Airbyte does NOT have active commitments to support this API long-term. * OSS users can utilize the Configuration API, but at their own risk. * This API is utilized internally by the Airbyte Engineering team and may be modified in the future if the need arises. * Modifications by the Airbyte Engineering team could create breaking changes and OSS users would need to update their code to catch up to any backwards incompatible changes in the 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/api/{VERSION}/{METHODFAMILY}/{METHODNAME} e.g. localhost:8000/api/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==\"
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
org.openapitools.codegen.languages.RustClientCodegenPut the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:
openapi = { path = "./openapi" }
All URIs are relative to http://localhost:8000/api
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AttemptApi | savestats | POST /v1/attempt/savestats | For worker to set sync stats of a running attempt. AttemptApi | savesyncconfig | POST /v1/attempt/savesyncconfig | For worker to save the AttemptSyncConfig for an attempt. AttemptApi | setworkflowinattempt | POST /v1/attempt/setworkflowinattempt | For worker to register the workflow id in attempt. ConnectionApi | createconnection | POST /v1/connections/create | Create a connection between a source and a destination *ConnectionApi* | deleteconnection | POST /v1/connections/delete | Delete a connection ConnectionApi | getconnection | POST /v1/connections/get | Get a connection *ConnectionApi* | listallconnectionsforworkspace | POST /v1/connections/listall | Returns all connections for a workspace, including deleted connections. ConnectionApi | listconnectionsbyactordefinition | POST /v1/connections/listbyactordefinition | List all connections that use the provided actor definition *ConnectionApi* | listconnectionsforworkspace | POST /v1/connections/list | Returns all connections for a workspace. ConnectionApi | resetconnection | 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. *ConnectionApi* | resetconnectionstream | POST /v1/connections/reset/stream | Reset the data for a specific stream in the connection. Deletes data generated by the stream in the destination. Resets any cursors back to initial state. *ConnectionApi* | searchconnections | POST /v1/connections/search | Search connections ConnectionApi | syncconnection | POST /v1/connections/sync | Trigger a manual sync of the connection *ConnectionApi* | updateconnection | POST /v1/connections/update | Update a connection ConnectorBuilderProjectApi | createconnectorbuilderproject | POST /v1/connectorbuilderprojects/create | Create new connector builder project *ConnectorBuilderProjectApi* | deleteconnectorbuilderproject | POST /v1/connectorbuilderprojects/delete | Deletes connector builder project ConnectorBuilderProjectApi | getconnectorbuilderproject | POST /v1/connectorbuilderprojects/getwithmanifest | Get a connector builder project with draft manifest *ConnectorBuilderProjectApi* | listconnectorbuilderprojects | POST /v1/connectorbuilderprojects/list | List connector builder projects for workspace ConnectorBuilderProjectApi | publishconnectorbuilderproject | POST /v1/connectorbuilderprojects/publish | Publish a connector to the workspace *ConnectorBuilderProjectApi* | updateconnectorbuilderproject | POST /v1/connectorbuilderprojects/update | Update connector builder project DeclarativeSourceDefinitionsApi | createdeclarativesourcedefinitionmanifest | POST /v1/declarativesourcedefinitions/createmanifest | Create a declarative manifest to be used by the specified source definition *DeclarativeSourceDefinitionsApi* | listdeclarativemanifests | POST /v1/declarativesourcedefinitions/listmanifests | List all available declarative manifest versions of a declarative source definition DeclarativeSourceDefinitionsApi | updatedeclarativemanifestversion | POST /v1/declarativesourcedefinitions/updateactivemanifest | Update the declarative manifest version for a source *DestinationApi* | checkconnectiontodestination | POST /v1/destinations/checkconnection | Check connection to the destination *DestinationApi* | checkconnectiontodestinationforupdate | POST /v1/destinations/checkconnectionforupdate | Check connection for a proposed update to a destination *DestinationApi* | clonedestination | POST /v1/destinations/clone | Clone destination DestinationApi | createdestination | POST /v1/destinations/create | Create a destination *DestinationApi* | deletedestination | POST /v1/destinations/delete | Delete the destination DestinationApi | getdestination | POST /v1/destinations/get | Get configured destination *DestinationApi* | listdestinationsforworkspace | POST /v1/destinations/list | List configured destinations for a workspace DestinationApi | partialupdatedestination | POST /v1/destinations/partialupdate | Update a destination partially *DestinationApi* | searchdestinations | POST /v1/destinations/search | Search destinations DestinationApi | updatedestination | POST /v1/destinations/update | Update a destination *DestinationDefinitionApi* | createcustomdestinationdefinition | POST /v1/destinationdefinitions/createcustom | Creates a custom destinationDefinition for the given workspace DestinationDefinitionApi | deletedestinationdefinition | POST /v1/destinationdefinitions/delete | Delete a destination definition *DestinationDefinitionApi* | getdestinationdefinition | POST /v1/destinationdefinitions/get | Get destinationDefinition DestinationDefinitionApi | getdestinationdefinitionforworkspace | POST /v1/destinationdefinitions/getforworkspace | Get a destinationDefinition that is configured for the given workspace *DestinationDefinitionApi* | grantdestinationdefinitiontoworkspace | POST /v1/destinationdefinitions/grantdefinition | grant a private, non-custom destinationDefinition to a given workspace *DestinationDefinitionApi* | listdestinationdefinitions | POST /v1/destinationdefinitions/list | List all the destinationDefinitions the current Airbyte deployment is configured to use DestinationDefinitionApi | listdestinationdefinitionsforworkspace | POST /v1/destinationdefinitions/listforworkspace | List all the destinationDefinitions the given workspace is configured to use *DestinationDefinitionApi* | listlatestdestinationdefinitions | POST /v1/destinationdefinitions/listlatest | List the latest destinationDefinitions Airbyte supports DestinationDefinitionApi | listprivatedestinationdefinitions | POST /v1/destinationdefinitions/listprivate | 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. *DestinationDefinitionApi* | revokedestinationdefinitionfromworkspace | POST /v1/destinationdefinitions/revokedefinition | revoke a grant to a private, non-custom destinationDefinition from a given workspace *DestinationDefinitionApi* | updatedestinationdefinition | POST /v1/destinationdefinitions/update | Update destinationDefinition DestinationDefinitionSpecificationApi | getdestinationdefinitionspecification | POST /v1/destinationdefinitionspecifications/get | Get specification for a destinationDefinition *DestinationDefinitionSpecificationApi* | getspecificationfordestinationid | POST /v1/destinationdefinitionspecifications/getfordestination | Get specification for a destination *DestinationOauthApi* | completedestinationoauth | POST /v1/destinationoauths/completeoauth | Given a destination def ID generate an access/refresh token etc. DestinationOauthApi | getdestinationoauthconsent | POST /v1/destinationoauths/getconsenturl | Given a destination connector definition ID, return the URL to the consent screen where to redirect the user to. *DestinationOauthApi* | setinstancewidedestinationoauthparams | POST /v1/destinationoauths/oauthparams/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 developertoken, clientid, and clientsecret without the user having to know about these variables. HealthApi | gethealthcheck | GET /v1/health | Health Check InternalApi | createorupdatestate | POST /v1/state/createorupdate | Create or update the state for a connection. *InternalApi* | getattemptnormalizationstatusesforjob | POST /v1/jobs/getnormalizationstatus | Get normalization status to determine if we can bypass normalization phase InternalApi | savestats | POST /v1/attempt/savestats | For worker to set sync stats of a running attempt. InternalApi | savesyncconfig | POST /v1/attempt/savesyncconfig | For worker to save the AttemptSyncConfig for an attempt. InternalApi | setworkflowinattempt | POST /v1/attempt/setworkflowinattempt | For worker to register the workflow id in attempt. InternalApi | writediscovercatalogresult | POST /v1/sources/writediscovercatalogresult | Should only called from worker, to write result from discover activity back to DB. JobsApi | canceljob | POST /v1/jobs/cancel | Cancels a job *JobsApi* | getattemptnormalizationstatusesforjob | POST /v1/jobs/getnormalizationstatus | Get normalization status to determine if we can bypass normalization phase JobsApi | getjobdebuginfo | POST /v1/jobs/getdebuginfo | Gets all information needed to debug this job *JobsApi* | getjobinfo | POST /v1/jobs/get | Get information about a job *JobsApi* | getjobinfolight | POST /v1/jobs/getlight | Get information about a job excluding attempt info and logs *JobsApi* | getjobinfowithoutlogs | POST /v1/jobs/getwithoutlogs | Get information about a job excluding logs *JobsApi* | getlastreplicationjob | POST /v1/jobs/getlastreplicationjob | *JobsApi* | listjobsfor | POST /v1/jobs/list | Returns recent jobs for a connection. Jobs are returned in descending order by createdAt. *LogsApi* | getlogs | POST /v1/logs/get | Get logs NotificationsApi | trynotificationconfig | POST /v1/notifications/try | Try sending a notifications OpenapiApi | getopenapispec | GET /v1/openapi | Returns the openapi specification *OperationApi* | checkoperation | POST /v1/operations/check | Check if an operation to be created is valid OperationApi | createoperation | POST /v1/operations/create | Create an operation to be applied as part of a connection pipeline *OperationApi* | deleteoperation | POST /v1/operations/delete | Delete an operation OperationApi | getoperation | POST /v1/operations/get | Returns an operation *OperationApi* | listoperationsforconnection | POST /v1/operations/list | Returns all operations for a connection. OperationApi | updateoperation | POST /v1/operations/update | Update an operation *SchedulerApi* | executedestinationcheckconnection | POST /v1/scheduler/destinations/checkconnection | Run check connection for a given destination configuration *SchedulerApi* | executesourcecheckconnection | POST /v1/scheduler/sources/checkconnection | Run check connection for a given source configuration *SchedulerApi* | executesourcediscoverschema | POST /v1/scheduler/sources/discoverschema | Run discover schema for a given source a source configuration *SourceApi* | applyschemachangeforsource | POST /v1/sources/applyschemachanges | Auto propagate the change on a catalog to a catalog saved in the DB. It will fetch all the connections linked to a source id and apply the provided diff to their catalog. *SourceApi* | checkconnectiontosource | POST /v1/sources/checkconnection | Check connection to the source *SourceApi* | checkconnectiontosourceforupdate | POST /v1/sources/checkconnectionforupdate | Check connection for a proposed update to a source *SourceApi* | clonesource | POST /v1/sources/clone | Clone source SourceApi | createsource | POST /v1/sources/create | Create a source *SourceApi* | deletesource | POST /v1/sources/delete | Delete a source SourceApi | discoverschemaforsource | POST /v1/sources/discoverschema | Discover the schema catalog of the source SourceApi | getmostrecentsourceactorcatalog | POST /v1/sources/mostrecentsourceactorcatalog | Get most recent ActorCatalog for source *SourceApi* | getsource | POST /v1/sources/get | Get source SourceApi | listsourcesforworkspace | POST /v1/sources/list | List sources for workspace *SourceApi* | partialupdatesource | POST /v1/sources/partialupdate | Partially update a source SourceApi | searchsources | POST /v1/sources/search | Search sources *SourceApi* | updatesource | POST /v1/sources/update | Update a source SourceApi | writediscovercatalogresult | POST /v1/sources/writediscovercatalogresult | Should only called from worker, to write result from discover activity back to DB. SourceDefinitionApi | createcustomsourcedefinition | POST /v1/sourcedefinitions/createcustom | Creates a custom sourceDefinition for the given workspace *SourceDefinitionApi* | deletesourcedefinition | POST /v1/sourcedefinitions/delete | Delete a source definition SourceDefinitionApi | getsourcedefinition | POST /v1/sourcedefinitions/get | Get source *SourceDefinitionApi* | getsourcedefinitionforworkspace | POST /v1/sourcedefinitions/getforworkspace | Get a sourceDefinition that is configured for the given workspace SourceDefinitionApi | grantsourcedefinitiontoworkspace | POST /v1/sourcedefinitions/grantdefinition | grant a private, non-custom sourceDefinition to a given workspace SourceDefinitionApi | listlatestsourcedefinitions | POST /v1/sourcedefinitions/listlatest | List the latest sourceDefinitions Airbyte supports *SourceDefinitionApi* | listprivatesourcedefinitions | POST /v1/sourcedefinitions/listprivate | 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. SourceDefinitionApi | listsourcedefinitions | POST /v1/sourcedefinitions/list | List all the sourceDefinitions the current Airbyte deployment is configured to use *SourceDefinitionApi* | listsourcedefinitionsforworkspace | POST /v1/sourcedefinitions/listforworkspace | List all the sourceDefinitions the given workspace is configured to use SourceDefinitionApi | revokesourcedefinitionfromworkspace | POST /v1/sourcedefinitions/revokedefinition | revoke a grant to a private, non-custom sourceDefinition from a given workspace SourceDefinitionApi | updatesourcedefinition | POST /v1/sourcedefinitions/update | Update a sourceDefinition *SourceDefinitionSpecificationApi* | getsourcedefinitionspecification | POST /v1/sourcedefinitionspecifications/get | Get specification for a SourceDefinition. SourceDefinitionSpecificationApi | getspecificationforsourceid | POST /v1/sourcedefinitionspecifications/getforsource | Get specification for a source. SourceOauthApi | completesourceoauth | POST /v1/sourceoauths/completeoauth | Given a source def ID generate an access/refresh token etc. *SourceOauthApi* | getsourceoauthconsent | POST /v1/sourceoauths/getconsenturl | Given a source connector definition ID, return the URL to the consent screen where to redirect the user to. SourceOauthApi | revokesourceoauthtokens | POST /v1/sourceoauths/revoke | Given a source definition ID and workspace ID revoke access/refresh token etc. *SourceOauthApi* | setinstancewidesourceoauthparams | POST /v1/sourceoauths/oauthparams/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 developertoken, clientid, and clientsecret without the user having to know about these variables. StateApi | createorupdatestate | POST /v1/state/createorupdate | Create or update the state for a connection. *StateApi* | getstate | POST /v1/state/get | Fetch the current state for a connection. StreamStatusesApi | createstreamstatus | POST /v1/streamstatuses/create | Creates a stream status. *StreamStatusesApi* | getstreamstatuses | POST /v1/streamstatuses/list | Gets a list of stream statuses filtered by parameters (with AND semantics). StreamStatusesApi | updatestreamstatus | POST /v1/streamstatuses/update | Updates a stream status. *StreamsApi* | createstreamstatus | POST /v1/streamstatuses/create | Creates a stream status. StreamsApi | getstreamstatuses | POST /v1/streamstatuses/list | Gets a list of stream statuses filtered by parameters (with AND semantics). *StreamsApi* | updatestreamstatus | POST /v1/streamstatuses/update | Updates a stream status. WebBackendApi | getstatetype | POST /v1/webbackend/state/gettype | Fetch the current state type for a connection. WebBackendApi | webbackendcheckupdates | POST /v1/webbackend/checkupdates | Returns a summary of source and destination definitions that could be updated. *WebBackendApi* | webbackendcreateconnection | POST /v1/webbackend/connections/create | Create a connection *WebBackendApi* | webbackendgetconnection | POST /v1/webbackend/connections/get | Get a connection *WebBackendApi* | webbackendgetworkspacestate | POST /v1/webbackend/workspace/state | Returns the current state of a workspace WebBackendApi | webbackendlistconnectionsforworkspace | POST /v1/webbackend/connections/list | Returns all non-deleted connections for a workspace. WebBackendApi | webbackendlistgeographies | POST /v1/webbackend/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. WebBackendApi | webbackendupdateconnection | POST /v1/webbackend/connections/update | Update a connection WorkspaceApi | createworkspace | POST /v1/workspaces/create | Creates a workspace *WorkspaceApi* | deleteworkspace | POST /v1/workspaces/delete | Deletes a workspace WorkspaceApi | getworkspace | POST /v1/workspaces/get | Find workspace by ID *WorkspaceApi* | getworkspacebyconnectionid | POST /v1/workspaces/getbyconnectionid | Find workspace by connection id WorkspaceApi | getworkspacebyslug | POST /v1/workspaces/getbyslug | Find workspace by slug *WorkspaceApi* | listworkspaces | POST /v1/workspaces/list | List all workspaces registered in the current Airbyte deployment WorkspaceApi | updateworkspace | POST /v1/workspaces/update | Update workspace state *WorkspaceApi* | updateworkspacefeedback | POST /v1/workspaces/tagfeedbackstatusasdone | Update workspace feedback state *WorkspaceApi* | updateworkspacename | POST /v1/workspaces/updatename | Update workspace name
To get access to the crate's generated documentation, use:
cargo doc --open
contact@airbyte.io