Airbyte Configuration API 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}/{METHODFAMILY}/{METHODNAME} 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.
Change Management:
* The major version of the API endpoint can be determined / specified in the URL localhost:8080/v1/connections/create
* Minor version bumps will be invisible to the end user. The user cannot specify minor versions in requests.
* All backwards incompatible changes will happen in major version bumps. We will not make backwards incompatible changes in minor version bumps. Examples of non-breaking changes (includes but not limited to...):
* Adding fields to request or response bodies.
* Adding new HTTP endpoints.
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 airbyte_client and add the following to Cargo.toml under [dependencies]:
airbyte_client = { path = "./airbyte_client" }
All URIs are relative to http://localhost:8000/api
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- 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* | getstate | POST /v1/state/get | Fetch the current state for a connection. ConnectionApi | listallconnectionsforworkspace | POST /v1/connections/listall | Returns all connections for a workspace, including deleted connections. *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* | 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 DbMigrationApi | executemigrations | POST /v1/dbmigrations/migrate | Migrate the database to the latest version DbMigrationApi | listmigrations | POST /v1/dbmigrations/list | List all database migrations DeploymentApi | exportarchive | POST /v1/deployment/export | Export Airbyte Configuration and Data Archive *DeploymentApi* | exportworkspace | POST /v1/deployment/exportworkspace | Export Airbyte Workspace Configuration *DeploymentApi* | importarchive | POST /v1/deployment/import | Import Airbyte Configuration and Data Archive DeploymentApi | importintoworkspace | POST /v1/deployment/importintoworkspace | Import Airbyte Configuration into Workspace (this operation might change ids of imported configurations). Note, in order to use this api endpoint, you might need to upload a temporary archive resource with 'deployment/uploadarchiveresource' first DeploymentApi | uploadarchiveresource | POST /v1/deployment/uploadarchiveresource | Upload a GZIP archive tarball and stage it in the server's cache as a temporary resource 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 | 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 | searchdestinations | POST /v1/destinations/search | Search destinations *DestinationApi* | updatedestination | POST /v1/destinations/update | Update a destination DestinationDefinitionApi | createdestinationdefinition | POST /v1/destinationdefinitions/create | Creates a destinationsDefinition *DestinationDefinitionApi* | deletedestinationdefinition | POST /v1/destinationdefinitions/delete | Delete a destination definition DestinationDefinitionApi | getdestinationdefinition | POST /v1/destinationdefinitions/get | Get destinationDefinition *DestinationDefinitionApi* | listdestinationdefinitions | POST /v1/destinationdefinitions/list | List all the destinationDefinitions the current Airbyte deployment is configured to use DestinationDefinitionApi | listlatestdestinationdefinitions | POST /v1/destinationdefinitions/listlatest | List the latest destinationDefinitions Airbyte supports *DestinationDefinitionApi* | updatedestinationdefinition | POST /v1/destinationdefinitions/update | Update destinationDefinition DestinationDefinitionSpecificationApi | getdestinationdefinitionspecification | POST /v1/destinationdefinitionspecifications/get | Get specification for a destinationDefinition *HealthApi* | gethealthcheck | GET /v1/health | Health Check *JobsApi* | canceljob | POST /v1/jobs/cancel | Cancels a job JobsApi | getjobinfo | POST /v1/jobs/get | Get information about a job 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 *OauthApi* | completedestinationoauth | POST /v1/destinationoauths/completeoauth | Given a destination def ID generate an access/refresh token etc. OauthApi | completesourceoauth | POST /v1/sourceoauths/completeoauth | Given a source def ID generate an access/refresh token etc. *OauthApi* | getdestinationoauthconsent | POST /v1/destinationoauths/getconsenturl | Given a destination connector definition ID, return the URL to the consent screen where to redirect the user to. OauthApi | getsourceoauthconsent | POST /v1/sourceoauths/getconsenturl | Given a source connector definition ID, return the URL to the consent screen where to redirect the user to. *OauthApi* | 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. OauthApi | 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. *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 | 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 | 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 | getsource | POST /v1/sources/get | Get source *SourceApi* | listsourcesforworkspace | POST /v1/sources/list | List sources for workspace SourceApi | searchsources | POST /v1/sources/search | Search sources *SourceApi* | updatesource | POST /v1/sources/update | Update a source SourceDefinitionApi | createsourcedefinition | POST /v1/sourcedefinitions/create | Creates a sourceDefinition *SourceDefinitionApi* | deletesourcedefinition | POST /v1/sourcedefinitions/delete | Delete a source definition SourceDefinitionApi | getsourcedefinition | POST /v1/sourcedefinitions/get | Get source *SourceDefinitionApi* | listlatestsourcedefinitions | POST /v1/sourcedefinitions/listlatest | List the latest sourceDefinitions Airbyte supports SourceDefinitionApi | listsourcedefinitions | POST /v1/sourcedefinitions/list | List all the sourceDefinitions the current Airbyte deployment is configured to use *SourceDefinitionApi* | updatesourcedefinition | POST /v1/sourcedefinitions/update | Update a sourceDefinition SourceDefinitionSpecificationApi | getsourcedefinitionspecification | POST /v1/sourcedefinitionspecifications/get | Get specification for a SourceDefinition. *WebBackendApi* | webbackendcreateconnection | POST /v1/webbackend/connections/create | Create a connection *WebBackendApi* | webbackendgetconnection | POST /v1/webbackend/connections/get | Get a connection *WebBackendApi* | webbackendlistallconnectionsforworkspace | POST /v1/webbackend/connections/listall | Returns all connections for a workspace. *WebBackendApi* | webbackendlistconnectionsforworkspace | POST /v1/webbackend/connections/list | Returns all non-deleted connections for a workspace. *WebBackendApi* | webbackendsearchconnections | POST /v1/webbackend/connections/search | Search connections *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 | 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/tagfeedbackstatusas_done | Update workspace feedback state
To get access to the crate's generated documentation, use:
cargo doc --open