Python Client SDK for Airbyte API
Project description
Authentication
Developers will need to create an API Key within your Developer Portal to 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 a walkthrough 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.
Summary
airbyte-api: Programatically control Airbyte Cloud, OSS & Enterprise.
Table of Contents
- SDK Installation
- SDK Example Usage
- Available Resources and Operations
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
SDK Installation
The SDK can be installed using the pip package manager, with dependencies and metadata stored in the setup.py
file.
pip install airbyte-api
SDK Example Usage
Example
import airbyte_api
from airbyte_api import models
s = airbyte_api.AirbyteAPI(
security=models.Security(
basic_auth=models.SchemeBasicAuth(
password="",
username="",
),
),
)
res = s.connections.create_connection(request=models.ConnectionCreateRequest(
destination_id='e478de0d-a3a0-475c-b019-25f7dd29e281',
source_id='95e66a59-8045-4307-9678-63bc3c9b8c93',
name='Postgres-to-Bigquery',
namespace_format='${SOURCE_NAMESPACE}',
))
if res.connection_response is not None:
# handle response
pass
Available Resources and Operations
Available methods
connections
- create_connection - Create a connection
- delete_connection - Delete a Connection
- get_connection - Get Connection details
- list_connections - List connections
- patch_connection - Update Connection details
destinations
- create_destination - Create a destination
- delete_destination - Delete a Destination
- get_destination - Get Destination details
- list_destinations - List destinations
- patch_destination - Update a Destination
- put_destination - Update a Destination and fully overwrite it
health
- get_health_check - Health Check
jobs
- cancel_job - Cancel a running Job
- create_job - Trigger a sync or reset job of a connection
- get_job - Get Job status and details
- list_jobs - List Jobs by sync type
organizations
- list_organizations_for_user - List all organizations for a user
permissions
- create_permission - Create a permission
- delete_permission - Delete a Permission
- get_permission - Get Permission details
- list_permissions - List Permissions by user id
- update_permission - Update a permission
sources
- create_source - Create a source
- delete_source - Delete a Source
- get_source - Get Source details
- initiate_o_auth - Initiate OAuth for a source
- list_sources - List sources
- patch_source - Update a Source
- put_source - Update a Source and fully overwrite it
streams
- get_stream_properties - Get stream properties
users
- list_users_within_an_organization - List all users within an organization
workspaces
- create_or_update_workspace_o_auth_credentials - Create OAuth override credentials for a workspace and source type.
- create_workspace - Create a workspace
- delete_workspace - Delete a Workspace
- get_workspace - Get Workspace details
- list_workspaces - List workspaces
- update_workspace - Update a workspace
Error Handling
Handling 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 Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Example
import airbyte_api
from airbyte_api import errors, models
s = airbyte_api.AirbyteAPI(
security=models.Security(
basic_auth=models.SchemeBasicAuth(
password="",
username="",
),
),
)
res = None
try:
res = s.connections.create_connection(request=models.ConnectionCreateRequest(
destination_id='e478de0d-a3a0-475c-b019-25f7dd29e281',
source_id='95e66a59-8045-4307-9678-63bc3c9b8c93',
name='Postgres-to-Bigquery',
namespace_format='${SOURCE_NAMESPACE}',
))
except errors.SDKError as e:
# handle exception
raise(e)
if res.connection_response is not None:
# handle response
pass
Server Selection
Select Server by Index
You can override the default server globally by passing a server index to the server_idx: int
optional 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:
# | Server | Variables |
---|---|---|
0 | https://api.airbyte.com/v1 |
None |
Example
import airbyte_api
from airbyte_api import models
s = airbyte_api.AirbyteAPI(
server_idx=0,
security=models.Security(
basic_auth=models.SchemeBasicAuth(
password="",
username="",
),
),
)
res = s.connections.create_connection(request=models.ConnectionCreateRequest(
destination_id='e478de0d-a3a0-475c-b019-25f7dd29e281',
source_id='95e66a59-8045-4307-9678-63bc3c9b8c93',
name='Postgres-to-Bigquery',
namespace_format='${SOURCE_NAMESPACE}',
))
if res.connection_response is not None:
# handle response
pass
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the server_url: str
optional parameter when initializing the SDK client instance. For example:
import airbyte_api
from airbyte_api import models
s = airbyte_api.AirbyteAPI(
server_url="https://api.airbyte.com/v1",
security=models.Security(
basic_auth=models.SchemeBasicAuth(
password="",
username="",
),
),
)
res = s.connections.create_connection(request=models.ConnectionCreateRequest(
destination_id='e478de0d-a3a0-475c-b019-25f7dd29e281',
source_id='95e66a59-8045-4307-9678-63bc3c9b8c93',
name='Postgres-to-Bigquery',
namespace_format='${SOURCE_NAMESPACE}',
))
if res.connection_response is not None:
# handle response
pass
Custom HTTP Client
The Python SDK makes API calls using the requests HTTP 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 custom requests.Session
object.
For example, you could specify a header for every request that this sdk makes as follows:
import airbyte_api
import requests
http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = airbyte_api.AirbyteAPI(client=http_client)
Authentication
Per-Client Security Schemes
This SDK supports the following security schemes globally:
Name | Type | Scheme |
---|---|---|
basic_auth |
http | HTTP Basic |
bearer_auth |
http | HTTP Bearer |
client_credentials |
oauth2 | OAuth2 token |
You can set the security parameters through the security
optional 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:
import airbyte_api
from airbyte_api import models
s = airbyte_api.AirbyteAPI(
security=models.Security(
basic_auth=models.SchemeBasicAuth(
password="",
username="",
),
),
)
res = s.connections.create_connection(request=models.ConnectionCreateRequest(
destination_id='e478de0d-a3a0-475c-b019-25f7dd29e281',
source_id='95e66a59-8045-4307-9678-63bc3c9b8c93',
name='Postgres-to-Bigquery',
namespace_format='${SOURCE_NAMESPACE}',
))
if res.connection_response is not None:
# handle response
pass
Maturity
This 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.
Contributions
While 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 by Speakeasy
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for airbyte_api-0.52.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b6d46820dd1d37c52bd3390d7037ef97592f46f37f81882a40ace888eae7e1ce |
|
MD5 | c80c405979f704a8e3696ed333796053 |
|
BLAKE2b-256 | 23acb176e6bbad9887e2194725aa4f43e5401e3622a252aee49c53dbcf1d2d03 |