Package: airbyte-api
Programatically control Airbyte Cloud through an API.AuthenticationDevelopers will need to create an API Key within yourDeveloper Portalto make API requests. You can use your existing Airbyte account to log in to the Developer Portal. Once you are in the Developer Portal, use the API Keys tab to create or remove API Keys. You can see awalkthrough demo here🎦The Developer Portal UI can also be used to help build your integration by showing information about network requests in the Requests tab. API usage information is also available to you in the Usage tab.SDK Installationpipinstallairbyte-apiSDK Example UsageExampleimportairbytefromairbyte.modelsimportshareds=airbyte.Airbyte(security=shared.Security(basic_auth=shared.SchemeBasicAuth(password="<YOUR_PASSWORD_HERE>",username="<YOUR_USERNAME_HERE>",),),)req=shared.ConnectionCreateRequest(destination_id='c669dd1e-3620-483e-afc8-55914e0a570f',source_id='6dd427d8-3a55-4584-b835-842325b6c7b3',namespace_format='${SOURCE_NAMESPACE}',)res=s.connections.create_connection(req)ifres.connection_responseisnotNone:# handle responsepassAvailable Resources and Operationsconnectionscreate_connection- Create a connectiondelete_connection- Delete a Connectionget_connection- Get Connection detailslist_connections- List connectionspatch_connection- Update Connection detailsdestinationscreate_destination- Create a destinationdelete_destination- Delete a Destinationget_destination- Get Destination detailslist_destinations- List destinationspatch_destination- Update a Destinationput_destination- Update a Destination and fully overwrite itjobscancel_job- Cancel a running Jobcreate_job- Trigger a sync or reset job of a connectionget_job- Get Job status and detailslist_jobs- List Jobs by sync typesourcescreate_source- Create a sourcedelete_source- Delete a Sourceget_source- Get Source detailsinitiate_o_auth- Initiate OAuth for a sourcelist_sources- List sourcespatch_source- Update a Sourceput_source- Update a Source and fully overwrite itstreamsget_stream_properties- Get stream propertiesworkspacescreate_or_update_workspace_o_auth_credentials- Create OAuth override credentials for a workspace and source type.create_workspace- Create a workspacedelete_workspace- Delete a Workspaceget_workspace- Get Workspace detailslist_workspaces- List workspacesupdate_workspace- Update a workspaceError HandlingHandling errors in this SDK should largely match your expectations.  All operations return a response object or raise an error.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.Error ObjectStatus CodeContent Typeerrors.SDKError4x-5xx/Exampleimportairbytefromairbyte.modelsimporterrors,shareds=airbyte.Airbyte(security=shared.Security(basic_auth=shared.SchemeBasicAuth(password="<YOUR_PASSWORD_HERE>",username="<YOUR_USERNAME_HERE>",),),)req=shared.ConnectionCreateRequest(destination_id='c669dd1e-3620-483e-afc8-55914e0a570f',source_id='6dd427d8-3a55-4584-b835-842325b6c7b3',namespace_format='${SOURCE_NAMESPACE}',)res=Nonetry:res=s.connections.create_connection(req)excepterrors.SDKErrorase:# handle exceptionraise(e)ifres.connection_responseisnotNone:# handle responsepassServer SelectionSelect Server by IndexYou can override the default server globally by passing a server index to theserver_idx: intoptional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:#ServerVariables0https://api.airbyte.com/v1NoneExampleimportairbytefromairbyte.modelsimportshareds=airbyte.Airbyte(server_idx=0,security=shared.Security(basic_auth=shared.SchemeBasicAuth(password="<YOUR_PASSWORD_HERE>",username="<YOUR_USERNAME_HERE>",),),)req=shared.ConnectionCreateRequest(destination_id='c669dd1e-3620-483e-afc8-55914e0a570f',source_id='6dd427d8-3a55-4584-b835-842325b6c7b3',namespace_format='${SOURCE_NAMESPACE}',)res=s.connections.create_connection(req)ifres.connection_responseisnotNone:# handle responsepassOverride Server URL Per-ClientThe default server can also be overridden globally by passing a URL to theserver_url: stroptional parameter when initializing the SDK client instance. For example:importairbytefromairbyte.modelsimportshareds=airbyte.Airbyte(server_url="https://api.airbyte.com/v1",security=shared.Security(basic_auth=shared.SchemeBasicAuth(password="<YOUR_PASSWORD_HERE>",username="<YOUR_USERNAME_HERE>",),),)req=shared.ConnectionCreateRequest(destination_id='c669dd1e-3620-483e-afc8-55914e0a570f',source_id='6dd427d8-3a55-4584-b835-842325b6c7b3',namespace_format='${SOURCE_NAMESPACE}',)res=s.connections.create_connection(req)ifres.connection_responseisnotNone:# handle responsepassCustom HTTP ClientThe Python SDK makes API calls using therequestsHTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a customrequests.Sessionobject.For example, you could specify a header for every request that this sdk makes as follows:importairbyteimportrequestshttp_client=requests.Session()http_client.headers.update({'x-custom-header':'someValue'})s=airbyte.Airbyte(client:http_client)AuthenticationPer-Client Security SchemesThis SDK supports the following security schemes globally:NameTypeSchemebasic_authhttpHTTP Basicbearer_authhttpHTTP BearerYou can set the security parameters through thesecurityoptional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:importairbytefromairbyte.modelsimportshareds=airbyte.Airbyte(security=shared.Security(basic_auth=shared.SchemeBasicAuth(password="<YOUR_PASSWORD_HERE>",username="<YOUR_USERNAME_HERE>",),),)req=shared.ConnectionCreateRequest(destination_id='c669dd1e-3620-483e-afc8-55914e0a570f',source_id='6dd427d8-3a55-4584-b835-842325b6c7b3',namespace_format='${SOURCE_NAMESPACE}',)res=s.connections.create_connection(req)ifres.connection_responseisnotNone:# handle responsepassMaturityThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.ContributionsWhile we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !SDK Created bySpeakeasy