airbyte-api

<div align="center"> <img src="https://user-images.githubusercontent.com/68016351/222853569-b35cc448-6481-4cf2-a237-bd5da47e94fd.png" width="500"> <p>Programatically control Airbyte Cloud through an API.</p> <a href="https://reference.airbyte.com/reference/start"><img src="https://img.shields.io/static/v1?label=Docs&message=API Ref&color=000000&style=for-the-badge" /></a> <a href="https://github.com/airbytehq/airbyte-api-python-sdk/actions"><img src="https://img.shields.io/github/actions/workflow/status/airbytehq/airbyte-api-python-sdk/speakeasy_sdk_generation.yml?style=for-the-badge" /></a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" /></a> <a href="https://github.com/airbytehq/airbyte-api-python-sdk/releases"><img src="https://img.shields.io/github/v/release/airbytehq/airbyte-api-python-sdk?sort=semver&style=for-the-badge" /></a> </div>

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.

<!-- Start Summary [summary] -->

Summary

airbyte-api: Programmatically control Airbyte Cloud, OSS & Enterprise.

<!-- End Summary [summary] --> <!-- Start Table of Contents [toc] -->

Table of Contents

<!-- $toc-max-depth=2 -->

• Authentication
• SDK Installation
• SDK Example Usage
• Available Resources and Operations
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication

<!-- End Table of Contents [toc] --> <!-- Start SDK Installation [installation] -->

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

<!-- End SDK Installation [installation] --> <!-- Start SDK Example Usage [usage] -->

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',
))

if res.connection_response is not None:
    # handle response
    pass

<!-- End SDK Example Usage [usage] --> <!-- Start Available Resources and Operations [operations] -->

Available Resources and Operations

<details open> <summary>Available methods</summary>

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

declarative_source_definitions

• create_declarative_source_definition - Create a declarative source definition.
• delete_declarative_source_definition - Delete a declarative source definition.
• get_declarative_source_definition - Get declarative source definition details.
• list_declarative_source_definitions - List declarative source definitions.
• update_declarative_source_definition - Update declarative source definition details.

destination_definitions

• create_destination_definition - Create a destination definition.
• delete_destination_definition - Delete a destination definition.
• get_destination_definition - Get destination definition details.
• list_destination_definitions - List destination definitions.
• update_destination_definition - Update destination definition 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

• create_or_update_organization_o_auth_credentials - Create OAuth override credentials for an organization and source type.
• list_organizations_for_user - List all organizations for a user

permissions

• [create_permission](https://github.com/airbyte