diff --git a/docs/.gitbook/assets/03_click.png b/docs/.gitbook/assets/03_click.png deleted file mode 100644 index 9f5eeec18231..000000000000 Binary files a/docs/.gitbook/assets/03_click.png and /dev/null differ diff --git a/docs/.gitbook/assets/05_app-name-modal.png b/docs/.gitbook/assets/05_app-name-modal.png deleted file mode 100644 index 37cda82d18cb..000000000000 Binary files a/docs/.gitbook/assets/05_app-name-modal.png and /dev/null differ diff --git a/docs/.gitbook/assets/08_activate-webhook.png b/docs/.gitbook/assets/08_activate-webhook.png deleted file mode 100644 index ac8f53a5b714..000000000000 Binary files a/docs/.gitbook/assets/08_activate-webhook.png and /dev/null differ diff --git a/docs/.gitbook/assets/10.png b/docs/.gitbook/assets/10.png deleted file mode 100644 index e1addcc0ef38..000000000000 Binary files a/docs/.gitbook/assets/10.png and /dev/null differ diff --git a/docs/.gitbook/assets/18.png b/docs/.gitbook/assets/18.png deleted file mode 100644 index c3ab0982709b..000000000000 Binary files a/docs/.gitbook/assets/18.png and /dev/null differ diff --git a/docs/.gitbook/assets/19.png b/docs/.gitbook/assets/19.png deleted file mode 100644 index 43f415ed00fb..000000000000 Binary files a/docs/.gitbook/assets/19.png and /dev/null differ diff --git a/docs/.gitbook/assets/2.png b/docs/.gitbook/assets/2.png deleted file mode 100644 index 08c6275d862a..000000000000 Binary files a/docs/.gitbook/assets/2.png and /dev/null differ diff --git a/docs/.gitbook/assets/20.png b/docs/.gitbook/assets/20.png deleted file mode 100644 index 06f221b15389..000000000000 Binary files a/docs/.gitbook/assets/20.png and /dev/null differ diff --git a/docs/.gitbook/assets/4.png b/docs/.gitbook/assets/4.png deleted file mode 100644 index b5546a70cf70..000000000000 Binary files a/docs/.gitbook/assets/4.png and /dev/null differ diff --git a/docs/.gitbook/assets/43.png b/docs/.gitbook/assets/43.png deleted file mode 100644 index da8888eb0811..000000000000 Binary files a/docs/.gitbook/assets/43.png and /dev/null differ diff --git a/docs/.gitbook/assets/44.png b/docs/.gitbook/assets/44.png deleted file mode 100644 index 1cc00895982b..000000000000 Binary files a/docs/.gitbook/assets/44.png and /dev/null differ diff --git a/docs/.gitbook/assets/45.png b/docs/.gitbook/assets/45.png deleted file mode 100644 index f4659f3b7907..000000000000 Binary files a/docs/.gitbook/assets/45.png and /dev/null differ diff --git a/docs/.gitbook/assets/46.png b/docs/.gitbook/assets/46.png deleted file mode 100644 index f67b11d20a23..000000000000 Binary files a/docs/.gitbook/assets/46.png and /dev/null differ diff --git a/docs/.gitbook/assets/5.png b/docs/.gitbook/assets/5.png deleted file mode 100644 index cce3d3400ed1..000000000000 Binary files a/docs/.gitbook/assets/5.png and /dev/null differ diff --git a/docs/.gitbook/assets/7.png b/docs/.gitbook/assets/7.png deleted file mode 100644 index ac086b0ca4b5..000000000000 Binary files a/docs/.gitbook/assets/7.png and /dev/null differ diff --git a/docs/.gitbook/assets/8.png b/docs/.gitbook/assets/8.png deleted file mode 100644 index 0ecb41269491..000000000000 Binary files a/docs/.gitbook/assets/8.png and /dev/null differ diff --git a/docs/.gitbook/assets/9.png b/docs/.gitbook/assets/9.png deleted file mode 100644 index 548b224e9b03..000000000000 Binary files a/docs/.gitbook/assets/9.png and /dev/null differ diff --git a/docs/.gitbook/assets/airbyte-ui-for-your-integration-pipelines.png b/docs/.gitbook/assets/airbyte-ui-for-your-integration-pipelines.png deleted file mode 100644 index 136322db68fe..000000000000 Binary files a/docs/.gitbook/assets/airbyte-ui-for-your-integration-pipelines.png and /dev/null differ diff --git a/docs/.gitbook/assets/airbyte_prefect_connection.png b/docs/.gitbook/assets/airbyte_prefect_connection.png deleted file mode 100644 index 17f67e660c84..000000000000 Binary files a/docs/.gitbook/assets/airbyte_prefect_connection.png and /dev/null differ diff --git a/docs/.gitbook/assets/airbyte_prefect_flow.png b/docs/.gitbook/assets/airbyte_prefect_flow.png deleted file mode 100644 index 5a8ffccb487e..000000000000 Binary files a/docs/.gitbook/assets/airbyte_prefect_flow.png and /dev/null differ diff --git a/docs/.gitbook/assets/airbyte_prefect_flow_configure_run.png b/docs/.gitbook/assets/airbyte_prefect_flow_configure_run.png deleted file mode 100644 index 8c46968abc3d..000000000000 Binary files a/docs/.gitbook/assets/airbyte_prefect_flow_configure_run.png and /dev/null differ diff --git a/docs/.gitbook/assets/airbyte_prefect_flow_run.png b/docs/.gitbook/assets/airbyte_prefect_flow_run.png deleted file mode 100644 index 4354f8e0bf1e..000000000000 Binary files a/docs/.gitbook/assets/airbyte_prefect_flow_run.png and /dev/null differ diff --git a/docs/.gitbook/assets/airbyte_prefect_register_flow.png b/docs/.gitbook/assets/airbyte_prefect_register_flow.png deleted file mode 100644 index 1a78a3870f1e..000000000000 Binary files a/docs/.gitbook/assets/airbyte_prefect_register_flow.png and /dev/null differ diff --git a/docs/.gitbook/assets/basic-normalization-configuration.png b/docs/.gitbook/assets/basic-normalization-configuration.png deleted file mode 100644 index 10cb3cb4bf44..000000000000 Binary files a/docs/.gitbook/assets/basic-normalization-configuration.png and /dev/null differ diff --git a/docs/.gitbook/assets/change-to-per-week (3) (3).png b/docs/.gitbook/assets/change-to-per-week (3) (3).png deleted file mode 100644 index 015d141aed6a..000000000000 Binary files a/docs/.gitbook/assets/change-to-per-week (3) (3).png and /dev/null differ diff --git a/docs/.gitbook/assets/cloud_onboarding.png b/docs/.gitbook/assets/cloud_onboarding.png deleted file mode 100644 index 8a303632eb48..000000000000 Binary files a/docs/.gitbook/assets/cloud_onboarding.png and /dev/null differ diff --git a/docs/.gitbook/assets/copy-personal-token.png b/docs/.gitbook/assets/copy-personal-token.png deleted file mode 100644 index f42751445a77..000000000000 Binary files a/docs/.gitbook/assets/copy-personal-token.png and /dev/null differ diff --git a/docs/.gitbook/assets/custom-dbt-transformations-seed.png b/docs/.gitbook/assets/custom-dbt-transformations-seed.png deleted file mode 100644 index 2ef2d1f23997..000000000000 Binary files a/docs/.gitbook/assets/custom-dbt-transformations-seed.png and /dev/null differ diff --git a/docs/.gitbook/assets/custom-dbt-transformations.png b/docs/.gitbook/assets/custom-dbt-transformations.png deleted file mode 100644 index 0a23e010538b..000000000000 Binary files a/docs/.gitbook/assets/custom-dbt-transformations.png and /dev/null differ diff --git a/docs/.gitbook/assets/demo_connection.png b/docs/.gitbook/assets/demo_connection.png deleted file mode 100644 index 2dd918f81386..000000000000 Binary files a/docs/.gitbook/assets/demo_connection.png and /dev/null differ diff --git a/docs/.gitbook/assets/demo_destination.png b/docs/.gitbook/assets/demo_destination.png deleted file mode 100644 index 955d712d2acb..000000000000 Binary files a/docs/.gitbook/assets/demo_destination.png and /dev/null differ diff --git a/docs/.gitbook/assets/demo_history.png b/docs/.gitbook/assets/demo_history.png deleted file mode 100644 index f96c35ec47f4..000000000000 Binary files a/docs/.gitbook/assets/demo_history.png and /dev/null differ diff --git a/docs/.gitbook/assets/demo_source.png b/docs/.gitbook/assets/demo_source.png deleted file mode 100644 index 7f293b2c92b1..000000000000 Binary files a/docs/.gitbook/assets/demo_source.png and /dev/null differ diff --git a/docs/.gitbook/assets/deploy-locally.svg b/docs/.gitbook/assets/deploy-locally.svg deleted file mode 100644 index 9540e40bcf13..000000000000 --- a/docs/.gitbook/assets/deploy-locally.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - - diff --git a/docs/.gitbook/assets/deploy-on-aws.svg b/docs/.gitbook/assets/deploy-on-aws.svg deleted file mode 100644 index 1b90bdf3a1f8..000000000000 --- a/docs/.gitbook/assets/deploy-on-aws.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - - diff --git a/docs/.gitbook/assets/deploy-on-gcp.svg b/docs/.gitbook/assets/deploy-on-gcp.svg deleted file mode 100644 index 620a22bb70a0..000000000000 --- a/docs/.gitbook/assets/deploy-on-gcp.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - - diff --git a/docs/.gitbook/assets/deploy_locally.svg b/docs/.gitbook/assets/deploy_locally.svg deleted file mode 100644 index 3a75de1889dd..000000000000 --- a/docs/.gitbook/assets/deploy_locally.svg +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - - - - - - - - - - - diff --git a/docs/.gitbook/assets/deploy_on_aws.svg b/docs/.gitbook/assets/deploy_on_aws.svg deleted file mode 100644 index 1f76d07a134c..000000000000 --- a/docs/.gitbook/assets/deploy_on_aws.svg +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - - - - - - - - - - - diff --git a/docs/.gitbook/assets/deploy_on_gcp.svg b/docs/.gitbook/assets/deploy_on_gcp.svg deleted file mode 100644 index 140e02a32f30..000000000000 --- a/docs/.gitbook/assets/deploy_on_gcp.svg +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - - - - - - - - - - - diff --git a/docs/.gitbook/assets/deploy_on_k8s.svg b/docs/.gitbook/assets/deploy_on_k8s.svg deleted file mode 100644 index a8a02d4ff1f4..000000000000 --- a/docs/.gitbook/assets/deploy_on_k8s.svg +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - - - - - - - - - - - diff --git a/docs/.gitbook/assets/duration-spent-in-weekly-webinars (3).png b/docs/.gitbook/assets/duration-spent-in-weekly-webinars (3).png deleted file mode 100644 index 441c104f5c07..000000000000 Binary files a/docs/.gitbook/assets/duration-spent-in-weekly-webinars (3).png and /dev/null differ diff --git a/docs/.gitbook/assets/evolution-of-meetings-per-week (3) (3).png b/docs/.gitbook/assets/evolution-of-meetings-per-week (3) (3).png deleted file mode 100644 index 23054ffc2ebc..000000000000 Binary files a/docs/.gitbook/assets/evolution-of-meetings-per-week (3) (3).png and /dev/null differ diff --git a/docs/.gitbook/assets/faq_stuck_onboarding.png b/docs/.gitbook/assets/faq_stuck_onboarding.png deleted file mode 100644 index 295299f0ff21..000000000000 Binary files a/docs/.gitbook/assets/faq_stuck_onboarding.png and /dev/null differ diff --git a/docs/.gitbook/assets/getting-started-connection.png b/docs/.gitbook/assets/getting-started-connection.png deleted file mode 100644 index a968a42cc17d..000000000000 Binary files a/docs/.gitbook/assets/getting-started-connection.png and /dev/null differ diff --git a/docs/.gitbook/assets/getting-started-destination.png b/docs/.gitbook/assets/getting-started-destination.png deleted file mode 100644 index 7971c3d66e14..000000000000 Binary files a/docs/.gitbook/assets/getting-started-destination.png and /dev/null differ diff --git a/docs/.gitbook/assets/getting-started-logs.png b/docs/.gitbook/assets/getting-started-logs.png deleted file mode 100644 index 8b83d64efc45..000000000000 Binary files a/docs/.gitbook/assets/getting-started-logs.png and /dev/null differ diff --git a/docs/.gitbook/assets/getting-started-source.png b/docs/.gitbook/assets/getting-started-source.png deleted file mode 100644 index ea13f5e44a89..000000000000 Binary files a/docs/.gitbook/assets/getting-started-source.png and /dev/null differ diff --git a/docs/.gitbook/assets/google_spreadsheet_url.png b/docs/.gitbook/assets/google_spreadsheet_url.png deleted file mode 100644 index 1678c3f1b991..000000000000 Binary files a/docs/.gitbook/assets/google_spreadsheet_url.png and /dev/null differ diff --git a/docs/.gitbook/assets/gridly_api_key1.png b/docs/.gitbook/assets/gridly_api_key1.png deleted file mode 100644 index 0b29ffbe9ec7..000000000000 Binary files a/docs/.gitbook/assets/gridly_api_key1.png and /dev/null differ diff --git a/docs/.gitbook/assets/gridly_api_key2.png b/docs/.gitbook/assets/gridly_api_key2.png deleted file mode 100644 index 0efd4b3e2d1b..000000000000 Binary files a/docs/.gitbook/assets/gridly_api_key2.png and /dev/null differ diff --git a/docs/.gitbook/assets/gridly_grid_id.png b/docs/.gitbook/assets/gridly_grid_id.png deleted file mode 100644 index 20f5cf703c60..000000000000 Binary files a/docs/.gitbook/assets/gridly_grid_id.png and /dev/null differ diff --git a/docs/.gitbook/assets/incremental_source_defined.png b/docs/.gitbook/assets/incremental_source_defined.png deleted file mode 100644 index 8fcb66c617fb..000000000000 Binary files a/docs/.gitbook/assets/incremental_source_defined.png and /dev/null differ diff --git a/docs/.gitbook/assets/incremental_user_defined.png b/docs/.gitbook/assets/incremental_user_defined.png deleted file mode 100644 index 3822d7f047a2..000000000000 Binary files a/docs/.gitbook/assets/incremental_user_defined.png and /dev/null differ diff --git a/docs/.gitbook/assets/launch (3) (3).png b/docs/.gitbook/assets/launch (3) (3).png deleted file mode 100644 index cfcc543a16bf..000000000000 Binary files a/docs/.gitbook/assets/launch (3) (3).png and /dev/null differ diff --git a/docs/.gitbook/assets/meetings-participant-ranked (3) (3).png b/docs/.gitbook/assets/meetings-participant-ranked (3) (3).png deleted file mode 100644 index 2f943f18e902..000000000000 Binary files a/docs/.gitbook/assets/meetings-participant-ranked (3) (3).png and /dev/null differ diff --git a/docs/.gitbook/assets/meetings-table.png b/docs/.gitbook/assets/meetings-table.png deleted file mode 100644 index d95edcaf1556..000000000000 Binary files a/docs/.gitbook/assets/meetings-table.png and /dev/null differ diff --git a/docs/.gitbook/assets/newsourcetutorial_add_destination.png b/docs/.gitbook/assets/newsourcetutorial_add_destination.png deleted file mode 100644 index 77f98b5ca2bf..000000000000 Binary files a/docs/.gitbook/assets/newsourcetutorial_add_destination.png and /dev/null differ diff --git a/docs/.gitbook/assets/newsourcetutorial_add_destination_new_destination.png b/docs/.gitbook/assets/newsourcetutorial_add_destination_new_destination.png deleted file mode 100644 index cf248cbad27f..000000000000 Binary files a/docs/.gitbook/assets/newsourcetutorial_add_destination_new_destination.png and /dev/null differ diff --git a/docs/.gitbook/assets/newsourcetutorial_configure_connection.png b/docs/.gitbook/assets/newsourcetutorial_configure_connection.png deleted file mode 100644 index 93af3a2a85b0..000000000000 Binary files a/docs/.gitbook/assets/newsourcetutorial_configure_connection.png and /dev/null differ diff --git a/docs/.gitbook/assets/newsourcetutorial_connection_done.png b/docs/.gitbook/assets/newsourcetutorial_connection_done.png deleted file mode 100644 index ebef8a12f1a1..000000000000 Binary files a/docs/.gitbook/assets/newsourcetutorial_connection_done.png and /dev/null differ diff --git a/docs/.gitbook/assets/newsourcetutorial_find_your_connector.png b/docs/.gitbook/assets/newsourcetutorial_find_your_connector.png deleted file mode 100644 index dbe57a207424..000000000000 Binary files a/docs/.gitbook/assets/newsourcetutorial_find_your_connector.png and /dev/null differ diff --git a/docs/.gitbook/assets/newsourcetutorial_first_sync.png b/docs/.gitbook/assets/newsourcetutorial_first_sync.png deleted file mode 100644 index bff5758b11e6..000000000000 Binary files a/docs/.gitbook/assets/newsourcetutorial_first_sync.png and /dev/null differ diff --git a/docs/.gitbook/assets/newsourcetutorial_new_connector_modal.png b/docs/.gitbook/assets/newsourcetutorial_new_connector_modal.png deleted file mode 100644 index 5e283a4b11f7..000000000000 Binary files a/docs/.gitbook/assets/newsourcetutorial_new_connector_modal.png and /dev/null differ diff --git a/docs/.gitbook/assets/newsourcetutorial_plop.gif b/docs/.gitbook/assets/newsourcetutorial_plop.gif deleted file mode 100644 index fdab07973e2f..000000000000 Binary files a/docs/.gitbook/assets/newsourcetutorial_plop.gif and /dev/null differ diff --git a/docs/.gitbook/assets/newsourcetutorial_settings_page.png b/docs/.gitbook/assets/newsourcetutorial_settings_page.png deleted file mode 100644 index 5bc531de553b..000000000000 Binary files a/docs/.gitbook/assets/newsourcetutorial_settings_page.png and /dev/null differ diff --git a/docs/.gitbook/assets/newsourcetutorial_settings_sources_newconnector.png b/docs/.gitbook/assets/newsourcetutorial_settings_sources_newconnector.png deleted file mode 100644 index ae1f3d27adba..000000000000 Binary files a/docs/.gitbook/assets/newsourcetutorial_settings_sources_newconnector.png and /dev/null differ diff --git a/docs/.gitbook/assets/newsourcetutorial_sidebar_settings.png b/docs/.gitbook/assets/newsourcetutorial_sidebar_settings.png deleted file mode 100644 index 9fb6ac4fe910..000000000000 Binary files a/docs/.gitbook/assets/newsourcetutorial_sidebar_settings.png and /dev/null differ diff --git a/docs/.gitbook/assets/newsourcetutorial_source_config.png b/docs/.gitbook/assets/newsourcetutorial_source_config.png deleted file mode 100644 index 5bc5024da7cd..000000000000 Binary files a/docs/.gitbook/assets/newsourcetutorial_source_config.png and /dev/null differ diff --git a/docs/.gitbook/assets/newsourcetutorial_sources_navbar.png b/docs/.gitbook/assets/newsourcetutorial_sources_navbar.png deleted file mode 100644 index 7c46d472a395..000000000000 Binary files a/docs/.gitbook/assets/newsourcetutorial_sources_navbar.png and /dev/null differ diff --git a/docs/.gitbook/assets/newsourcetutorial_sources_page.png b/docs/.gitbook/assets/newsourcetutorial_sources_page.png deleted file mode 100644 index f5b7bb19d083..000000000000 Binary files a/docs/.gitbook/assets/newsourcetutorial_sources_page.png and /dev/null differ diff --git a/docs/.gitbook/assets/newsourcetutorial_sources_stock_ticker.png b/docs/.gitbook/assets/newsourcetutorial_sources_stock_ticker.png deleted file mode 100644 index 3b61e256a6e1..000000000000 Binary files a/docs/.gitbook/assets/newsourcetutorial_sources_stock_ticker.png and /dev/null differ diff --git a/docs/.gitbook/assets/notifications_add_new_webhook.png b/docs/.gitbook/assets/notifications_add_new_webhook.png deleted file mode 100644 index a39231782a74..000000000000 Binary files a/docs/.gitbook/assets/notifications_add_new_webhook.png and /dev/null differ diff --git a/docs/.gitbook/assets/notifications_airbyte_notification_settings.png b/docs/.gitbook/assets/notifications_airbyte_notification_settings.png deleted file mode 100644 index 194ccadecb27..000000000000 Binary files a/docs/.gitbook/assets/notifications_airbyte_notification_settings.png and /dev/null differ diff --git a/docs/.gitbook/assets/notifications_airbyte_settings.png b/docs/.gitbook/assets/notifications_airbyte_settings.png deleted file mode 100644 index d3919fb08cdd..000000000000 Binary files a/docs/.gitbook/assets/notifications_airbyte_settings.png and /dev/null differ diff --git a/docs/.gitbook/assets/notifications_create_slack_app.png b/docs/.gitbook/assets/notifications_create_slack_app.png deleted file mode 100644 index dc04e355e875..000000000000 Binary files a/docs/.gitbook/assets/notifications_create_slack_app.png and /dev/null differ diff --git a/docs/.gitbook/assets/notifications_incoming_webhooks.png b/docs/.gitbook/assets/notifications_incoming_webhooks.png deleted file mode 100644 index dec1899e5b56..000000000000 Binary files a/docs/.gitbook/assets/notifications_incoming_webhooks.png and /dev/null differ diff --git a/docs/.gitbook/assets/notifications_slack_message.png b/docs/.gitbook/assets/notifications_slack_message.png deleted file mode 100644 index 8002cf46ca39..000000000000 Binary files a/docs/.gitbook/assets/notifications_slack_message.png and /dev/null differ diff --git a/docs/.gitbook/assets/notifications_webhook_url.png b/docs/.gitbook/assets/notifications_webhook_url.png deleted file mode 100644 index 42cfce99c90d..000000000000 Binary files a/docs/.gitbook/assets/notifications_webhook_url.png and /dev/null differ diff --git a/docs/.gitbook/assets/number_of_participants_per_weekly_meetings.png b/docs/.gitbook/assets/number_of_participants_per_weekly_meetings.png deleted file mode 100644 index 93d839418cc0..000000000000 Binary files a/docs/.gitbook/assets/number_of_participants_per_weekly_meetings.png and /dev/null differ diff --git a/docs/.gitbook/assets/postgres_credentials (3) (3).png b/docs/.gitbook/assets/postgres_credentials (3) (3).png deleted file mode 100644 index b56bc6dc50a0..000000000000 Binary files a/docs/.gitbook/assets/postgres_credentials (3) (3).png and /dev/null differ diff --git a/docs/.gitbook/assets/primary_key_user_defined.png b/docs/.gitbook/assets/primary_key_user_defined.png deleted file mode 100644 index cf45c9c248dc..000000000000 Binary files a/docs/.gitbook/assets/primary_key_user_defined.png and /dev/null differ diff --git a/docs/.gitbook/assets/reset_your_data_1.png b/docs/.gitbook/assets/reset_your_data_1.png deleted file mode 100644 index 634d9ef29263..000000000000 Binary files a/docs/.gitbook/assets/reset_your_data_1.png and /dev/null differ diff --git a/docs/.gitbook/assets/schema (3) (3).png b/docs/.gitbook/assets/schema (3) (3).png deleted file mode 100644 index 9d4e5d4b6920..000000000000 Binary files a/docs/.gitbook/assets/schema (3) (3).png and /dev/null differ diff --git a/docs/.gitbook/assets/setup-custom-transformation.png b/docs/.gitbook/assets/setup-custom-transformation.png deleted file mode 100644 index a23cbfee400b..000000000000 Binary files a/docs/.gitbook/assets/setup-custom-transformation.png and /dev/null differ diff --git a/docs/.gitbook/assets/setup-successful (3) (2).png b/docs/.gitbook/assets/setup-successful (3) (2).png deleted file mode 100644 index 7d4f42151d9a..000000000000 Binary files a/docs/.gitbook/assets/setup-successful (3) (2).png and /dev/null differ diff --git a/docs/.gitbook/assets/slack-add-apps.png b/docs/.gitbook/assets/slack-add-apps.png deleted file mode 100644 index aeec0d38c463..000000000000 Binary files a/docs/.gitbook/assets/slack-add-apps.png and /dev/null differ diff --git a/docs/.gitbook/assets/slack-history-catalog.png b/docs/.gitbook/assets/slack-history-catalog.png deleted file mode 100644 index 85c543da982d..000000000000 Binary files a/docs/.gitbook/assets/slack-history-catalog.png and /dev/null differ diff --git a/docs/.gitbook/assets/slack-history-setup-wizard.png b/docs/.gitbook/assets/slack-history-setup-wizard.png deleted file mode 100644 index 2f33f057c421..000000000000 Binary files a/docs/.gitbook/assets/slack-history-setup-wizard.png and /dev/null differ diff --git a/docs/.gitbook/assets/slack-history-sync.png b/docs/.gitbook/assets/slack-history-sync.png deleted file mode 100644 index a4408da9b960..000000000000 Binary files a/docs/.gitbook/assets/slack-history-sync.png and /dev/null differ diff --git a/docs/.gitbook/assets/slack-history-ui-title.png b/docs/.gitbook/assets/slack-history-ui-title.png deleted file mode 100644 index da1a437af110..000000000000 Binary files a/docs/.gitbook/assets/slack-history-ui-title.png and /dev/null differ diff --git a/docs/.gitbook/assets/slack-history-ui.png b/docs/.gitbook/assets/slack-history-ui.png deleted file mode 100644 index a7bbd3396dc9..000000000000 Binary files a/docs/.gitbook/assets/slack-history-ui.png and /dev/null differ diff --git a/docs/.gitbook/assets/sync-screen (3) (3).png b/docs/.gitbook/assets/sync-screen (3) (3).png deleted file mode 100644 index 7c031ca71c36..000000000000 Binary files a/docs/.gitbook/assets/sync-screen (3) (3).png and /dev/null differ diff --git a/docs/.gitbook/assets/tableau-dashboard (3) (3).png b/docs/.gitbook/assets/tableau-dashboard (3) (3).png deleted file mode 100644 index b3c5c91b7bac..000000000000 Binary files a/docs/.gitbook/assets/tableau-dashboard (3) (3).png and /dev/null differ diff --git a/docs/.gitbook/assets/ux_hierarchy_pyramid.png b/docs/.gitbook/assets/ux_hierarchy_pyramid.png deleted file mode 100644 index df292f3b9b69..000000000000 Binary files a/docs/.gitbook/assets/ux_hierarchy_pyramid.png and /dev/null differ diff --git a/docs/.gitbook/assets/zoom-marketplace-build-screen (3) (3).png b/docs/.gitbook/assets/zoom-marketplace-build-screen (3) (3).png deleted file mode 100644 index f481e066aaa2..000000000000 Binary files a/docs/.gitbook/assets/zoom-marketplace-build-screen (3) (3).png and /dev/null differ diff --git a/docs/assets/docs/docs-contribution-keyboard.jpg b/docs/assets/docs/docs-contribution-keyboard.jpg deleted file mode 100644 index 0c2423d4ef38..000000000000 Binary files a/docs/assets/docs/docs-contribution-keyboard.jpg and /dev/null differ diff --git a/docs/assets/docs/docs.jpg b/docs/assets/docs/docs.jpg deleted file mode 100644 index 2349fd159a99..000000000000 Binary files a/docs/assets/docs/docs.jpg and /dev/null differ diff --git a/docs/assets/docs/science-kid.jpg b/docs/assets/docs/science-kid.jpg deleted file mode 100644 index c45f5c3a3724..000000000000 Binary files a/docs/assets/docs/science-kid.jpg and /dev/null differ diff --git a/docs/assets/docs/useless_example.jpg b/docs/assets/docs/useless_example.jpg deleted file mode 100644 index 2c967de789e1..000000000000 Binary files a/docs/assets/docs/useless_example.jpg and /dev/null differ diff --git a/docs/connector-development/tutorials/the-hard-way/build-a-connector-the-hard-way.md b/docs/connector-development/tutorials/the-hard-way/build-a-connector-the-hard-way.md index 98ab769a4420..22f4e37d012d 100644 --- a/docs/connector-development/tutorials/the-hard-way/build-a-connector-the-hard-way.md +++ b/docs/connector-development/tutorials/the-hard-way/build-a-connector-the-hard-way.md @@ -84,9 +84,7 @@ $ cd airbyte-integrations/connector-templates/generator $ ./generate.sh ``` -Select the `Generic Source` template and call the connector `stock-ticker-api`: - -![](../../../.gitbook/assets/newsourcetutorial_plop.gif) +Select the `Generic Source` template and call the connector `stock-ticker-api`. :::info @@ -1145,86 +1143,50 @@ After you see the above banner printed out in the terminal window where you are `docker compose up`, visit [http://localhost:8000](http://localhost:8000) in your browser and log in with the default credentials: username `airbyte` and password `password`. -If this is the first time using the Airbyte UI, then you will be prompted to go through a first-time -wizard. To skip it, click the "Skip Onboarding" button. - -In the UI, click the "Settings" button in the left side bar: - -![](../../../.gitbook/assets/newsourcetutorial_sidebar_settings.png) - -Then on the Settings page, select Sources - -![](../../../.gitbook/assets/newsourcetutorial_settings_page.png) +## Setup a connection to sync data in Airbyte -Then on the Settings/Sources page, click "+ New Connector" button at the top right: +1. In the UI, click the "Settings" button in the left side bar. Then on the Settings page, select Sources. -![](../../../.gitbook/assets/newsourcetutorial_settings_sources_newconnector.png) +2. Then on the Settings/Sources page, click "+ New Connector" button at the top right. -On the modal that pops up, enter the following information then click "Add" +3. On the modal that pops up, enter the following information then click "Add" -![](../../../.gitbook/assets/newsourcetutorial_new_connector_modal.png) - -After you click "Add", the modal will close and you will be back at the Settings page. Now click +4. After you click "Add", the modal will close and you will be back at the Settings page. Now click "Sources" in the navigation bar on the left: -![](../../../.gitbook/assets/newsourcetutorial_sources_navbar.png) - -You will be redirected to Sources page, which, if you have not set up any connections, will be +5. You will be redirected to Sources page, which, if you have not set up any connections, will be empty. On the Sources page click "+ new source" in the top right corner: -![](../../../.gitbook/assets/newsourcetutorial_sources_page.png) - -A new modal will prompt you for details of the new source. Type "Stock Ticker" in the Name field. +6. A new modal will prompt you for details of the new source. Type "Stock Ticker" in the Name field. Then, find your connector in the Source type dropdown. We have lots of connectors already, so it -might be easier to find your connector by typing part of its name: - -![](../../../.gitbook/assets/newsourcetutorial_find_your_connector.png) +might be easier to find your connector by typing part of its name. -After you select your connector in the Source type dropdown, the modal will show two more fields: -API Key and Stock Ticker. Remember that `spec.json` file you created at the very beginning of this +7. After you select your connector in the Source type dropdown, the modal will show two more fields: API Key and Stock Ticker. Remember that `spec.json` file you created at the very beginning of this tutorial? These fields should correspond to the `properties` section of that file. Copy-paste your Polygon.io API key and a stock ticker into these fields and then click "Set up source" button at the bottom right of the modal. -![](../../../.gitbook/assets/newsourcetutorial_source_config.png) - -Once you click "Set up source", Airbyte will spin up your connector and run "check" method to verify +8. Once you click "Set up source", Airbyte will spin up your connector and run "check" method to verify the configuration. You will see a progress bar briefly and if the configuration is valid, you will see a success message, the modal will close and you will see your connector on the updated Sources page. -![](../../../.gitbook/assets/newsourcetutorial_sources_stock_ticker.png) - -Next step is to add a destination. On the same page, click "add destination" and then click "+ add a +9. Next step is to add a destination. On the same page, click "add destination" and then click "+ add a new destination": -![](../../../.gitbook/assets/newsourcetutorial_add_destination_new_destination.png) - -"New destination" wizard will show up. Type a name (e.g. "Local JSON") into the Name field and +10. "New destination" wizard will show up. Type a name (e.g. "Local JSON") into the Name field and select "Local JSON" in Destination type drop-down. After you select the destination type, type `/local/tutorial_json` into Destination path field. When we run syncs, we'll find the output on our local filesystem in `/tmp/airbyte_local/tutorial_json`. -Click "Set up destination" at the lower right of the form. - -![](../../../.gitbook/assets/newsourcetutorial_add_destination.png) +11. Click "Set up destination" at the lower right of the form. -After that Airbyte will test the destination and prompt you to configure the connection between +12. After that Airbyte will test the destination and prompt you to configure the connection between Stock Ticker source and Local JSON destination. Select "Mirror source structure" in the Destination Namespace, check the checkbox next to the stock_prices stream, and click "Set up connection" button -at the bottom of the form: - -![](../../../.gitbook/assets/newsourcetutorial_configure_connection.png) - -Ta-da! Your connection is now configured to sync once a day. You will see your new connection on the -next screen: - -![](../../../.gitbook/assets/newsourcetutorial_connection_done.png) - -Airbyte will run the first sync job as soon as your connection is saved. Navigate to "Connections" -in the side bar and wait for the first sync to succeed: +at the bottom of the form. -![](../../../.gitbook/assets/newsourcetutorial_first_sync.png) +13. Ta-da! Your connection is now configured to sync once a day. Airbyte will run the first sync job as soon as your connection is saved. Navigate to "Connections" in the side bar and wait for the first sync to succeed: Let's verify the output. From your shell, run: diff --git a/docs/deploying-airbyte/docker-compose.md b/docs/deploying-airbyte/docker-compose.md deleted file mode 100644 index 2af199b0d3b4..000000000000 --- a/docs/deploying-airbyte/docker-compose.md +++ /dev/null @@ -1,77 +0,0 @@ -# Docker Compose - -:::info -These instructions have been tested on MacOS, Windows 10 and Ubuntu 22.04. - -::: - -## Setup & launch Airbyte - -- Install `Docker Engine` and the `Docker Compose plugin` on your workstation \(see [instructions](https://docs.docker.com/engine/install/)\). -- After Docker is installed, you can immediately get started locally by running: - -```bash -# clone Airbyte from GitHub -git clone --depth=1 https://github.com/airbytehq/airbyte.git - -# switch into Airbyte directory -cd airbyte - -# start Airbyte -./run-ab-platform.sh -``` - -- In your browser, visit [http://localhost:8000](http://localhost:8000) -- You will be asked for a username and password. By default, that's username `airbyte` and password `password`. Once you deploy Airbyte to your servers, be sure to change these in your `.env` file: - -```yaml -# Proxy Configuration -# Set to empty values, e.g. "" to disable basic auth -BASIC_AUTH_USERNAME=your_new_username_here -BASIC_AUTH_PASSWORD=your_new_password_here -``` - -- Start moving some data! - -## Deploy on Windows - -After installing the WSL 2 backend and Docker you should be able to run containers using Windows PowerShell. Additionally, as we note frequently, you will need `docker-compose` to build Airbyte from source. The suggested guide already installs `docker-compose` on Windows. - -### Setup Guide - -**1. Check out system requirements from [Docker documentation](https://docs.docker.com/desktop/windows/install/).** - -Follow the steps on the system requirements, and necessarily, download and install the Linux kernel update package. - -**2. Install Docker Desktop on Windows.** - -Install [Docker Desktop](https://docs.docker.com/desktop/windows/install/) from here. - -Make sure to select the options: - -1. _Enable Hyper-V Windows Features_ -2. _Install required Windows components for WSL 2_ - when prompted. After installation, it will require to reboot your computer. - -**3. You're done!** - -```bash -git clone --depth=1 https://github.com/airbytehq/airbyte.git -cd airbyte -bash run-ab-platform.sh -``` - -- In your browser, just visit [http://localhost:8000](http://localhost:8000) -- You will be asked for a username and password. By default, that's username `airbyte` and password `password`. Once you deploy airbyte to your servers, be sure to change these. -- Start moving some data! - -## Troubleshooting - -If you have any questions about the local setup and deployment process, head over to our [Getting Started FAQ](https://github.com/airbytehq/airbyte/discussions/categories/questions) on our Airbyte Forum that answers the following questions and more: - -- How long does it take to set up Airbyte? -- Where can I see my data once I've run a sync? -- Can I set a start time for my sync? - -If you encounter any issues, check out [Getting Support](/community/getting-support) documentation -for options how to get in touch with the community or us. diff --git a/docs/deploying-airbyte/integrations/storage.md b/docs/deploying-airbyte/integrations/storage.md index 10050c095277..e1410842da84 100644 --- a/docs/deploying-airbyte/integrations/storage.md +++ b/docs/deploying-airbyte/integrations/storage.md @@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem'; # State and Logging Storage Airbyte recommends using an object storage solution for such as S3 and GCS for storing [State](../../understanding-airbyte/airbyte-protocol/#state--checkpointing) and [Logging information](../../operator-guides/browsing-output-logs). -You must select which type of blob store that you wish to use. Currently, S3 and GCS are supported. If you are using an S3 compatible solution, use the S3 type and provide an `endpoint` key/value as needed. +You must select which type of blob store that you wish to use. Currently, S3, GCS, and Azure are supported. If you are using an S3 compatible solution, use the S3 type and provide an `endpoint` key/value as needed. Adding external storage details to your `values.yaml` disables the default internal Minio instance (`airbyte/minio`). While there are three separate buckets presented in the Values section below, Airbyte recommends that you use a single bucket across all three values. diff --git a/docs/deploying-airbyte/on-aws-ec2.md b/docs/deploying-airbyte/on-aws-ec2.md deleted file mode 100644 index 0bdaf7a6e954..000000000000 --- a/docs/deploying-airbyte/on-aws-ec2.md +++ /dev/null @@ -1,99 +0,0 @@ -# Deploy Airbyte on AWS (Amazon EC2) - -This page guides you through deploying Airbyte Open Source on an [Amazon EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html) by setting up the deployment environment, installing and starting Airbyte, and connecting it to the Amazon EC2 instance. - -:::info - -The instructions have been tested on Amazon Linux 2 AMI (HVM). - -::: - -## Requirements - -- To test Airbyte, we recommend a `t2.medium` instance -- To deploy Airbyte in a production environment, we recommend a `t2.large` instance -- Make sure your Docker Desktop app is running to ensure all services run smoothly -- [Create and download an SSH key to connect to the instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html) - -## Set up the environment - -1. To connect to your instance, run the following command on your local terminal: - -```bash -SSH_KEY=~/Downloads/dataline-key-airbyte.pem # the file path you downloaded the key -INSTANCE_IP=REPLACE_WITH_YOUR_INSTANCE_IP # find your IP address in the EC2 console under the Instances tab -chmod 400 $SSH_KEY # or ssh will complain that the key has the wrong permissions -ssh -i $SSH_KEY ec2-user@$INSTANCE_IP # connect to the aws ec2 instance AMI and the your private IP address -``` - -2. To install Docker, run the following command in your SSH session on the instance terminal: - -```bash -sudo yum update -y -sudo yum install -y docker -sudo service docker start -sudo usermod -a -G docker $USER -``` - -3. To install `docker-compose`, run the following command in your ssh session on the instance terminal: - -```bash -sudo yum install -y docker-compose-plugin -docker compose version -``` - -If you encounter an error on this part, you might prefer to follow the documentation to [install the docker compose plugin manually](https://docs.docker.com/compose/install/linux/#install-the-plugin-manually) (_make sure to do it for all users_). - -4. To close the SSH connection, run the following command in your SSH session on the instance terminal: - -```bash -logout -``` - -## Install and start Airbyte - -In your local terminal, run the following commands: - -1. Connect to your instance: - -```bash -ssh -i $SSH_KEY ec2-user@$INSTANCE_IP -``` - -2. Install Airbyte: - -```bash -mkdir airbyte && cd airbyte -wget https://raw.githubusercontent.com/airbytehq/airbyte/master/run-ab-platform.sh -chmod +x run-ab-platform.sh -./run-ab-platform.sh -b -``` - -## Connect to Airbyte - -:::caution - -For security reasons, we strongly recommend not exposing Airbyte on Internet available ports. - -::: - -1. Create an SSH tunnel for port 8000: - -If you want to use different ports, modify `API_URL` in your .env file and restart Airbyte. -Run the following commands in your workstation terminal from the downloaded key folder: - -```bash -# In your workstation terminal -SSH_KEY=~/Downloads/dataline-key-airbyte.pem -ssh -i $SSH_KEY -L 8000:localhost:8000 -N -f ec2-user@$INSTANCE_IP -``` - -2. Visit `http://localhost:8000` to verify the deployment. - -## Get Airbyte logs in CloudWatch - -Follow this [guide](https://aws.amazon.com/en/premiumsupport/knowledge-center/cloudwatch-docker-container-logs-proxy/) to get your logs from your Airbyte Docker containers in CloudWatch. - -## Troubleshooting - -If you encounter any issues, reach out to our community on [Slack](https://slack.airbyte.com/). diff --git a/docs/deploying-airbyte/on-aws-ecs.md b/docs/deploying-airbyte/on-aws-ecs.md deleted file mode 100644 index 8695604006a3..000000000000 --- a/docs/deploying-airbyte/on-aws-ecs.md +++ /dev/null @@ -1,12 +0,0 @@ -# On AWS ECS (Coming Soon) - -:::info - -We do not currently support deployment on ECS. - -::: - -The current iteration is not compatible with ECS. -Airbyte currently relies on docker containers being able to create other docker containers. -ECS does not permit containers to do this. We will be revising this strategy soon, -so that we can be compatible with ECS and other container services. diff --git a/docs/deploying-airbyte/on-azure-vm-cloud-shell.md b/docs/deploying-airbyte/on-azure-vm-cloud-shell.md deleted file mode 100644 index b261a7a13c5a..000000000000 --- a/docs/deploying-airbyte/on-azure-vm-cloud-shell.md +++ /dev/null @@ -1,111 +0,0 @@ -# Deploy Airbyte on Azure (Cloud Shell) - -This page guides you through deploying Airbyte Open Source on a [Microsoft Azure VM](https://learn.microsoft.com/en-us/azure/virtual-machines/) by setting up the deployment environment, installing and starting Airbyte, and connecting it to the VM. - -:::info - -The instructions have been tested on a standard DS1 v2 (1 vcpu, 3.5 GiB memory) Microsoft Azure VM with Ubuntu 18.04. - -::: - -## Set up the environment - -Install Docker and Docker Compose in the VM: - -1. [Create a new VM](https://learn.microsoft.com/en-us/azure/virtual-machines/) and [generate the SSH keys](https://learn.microsoft.com/en-us/azure/virtual-machines/ssh-keys-portal) to connect to the VM. You’ll need the SSH keys to connect to the VM remotely later. - -2. To connect to the VM, run the following command in the Azure Cloud Shell: - - ```bash - ssh @ - ``` - - If successfully connected to the VM, the working directory of Cloud Shell should look like this: `@:~$` - -3. To install Docker, run the following commands: - - ```bash - sudo apt-get update -y - sudo apt-get install apt-transport-https ca-certificates curl gnupg lsb-release -y - curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg - echo "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null - sudo apt-get update - sudo apt-get install docker-ce docker-ce-cli -y - sudo usermod -a -G docker $USER - ``` - -4. To install Docker Compose, run the following command: - - ```bash - sudo apt-get install docker-compose-plugin -y - ``` - -5. Check Docker Compose version: - - ```bash - docker compose version - ``` - -6. Close the SSH connection to ensure that the group modification is considered: - - ```bash - logout - ``` - -7. Reconnect to the VM: - - ```bash - ssh @ - ``` - -## Install and start Airbyte - -Download Airbyte and deploy it in the VM using Docker Compose: - -1. Ensure that you are connected to the VM: - - ```bash - ssh @ - ``` - -2. Create and use a new directory: - - ```bash - mkdir airbyte - cd airbyte - ``` - -3. Download Airbyte's install script from GitHub: - - ```bash - wget https://raw.githubusercontent.com/airbytehq/airbyte/master/run-ab-platform.sh - ``` - -4. To start Airbyte, run the following commands: - - ```bash - chmod +x run-ab-platform.sh - ./run-ab-platform.sh -b - ``` - -## Connect to Airbyte - -Test a remote connection to your VM locally and verify that Airbyte is up and running. - -1. In your local machine, open a terminal. -2. Go to the folder where you stored the SSH key. -3. Create a SSH tunnel for `port 8000` by typing the following command: - - ```bash - ssh -N -L 8000:localhost:8000 -i @ - ``` - -4. Open a web browser and navigate to `http://localhost:8000`. You will see Airbyte’s landing page. - -:::caution -For security reasons, we strongly recommend not exposing Airbyte on Internet available ports. -::: - -## Troubleshooting - -If you encounter any issues, reach out to our community on [Slack](https://slack.airbyte.com/). diff --git a/docs/deploying-airbyte/on-cloud.md b/docs/deploying-airbyte/on-cloud.md deleted file mode 100644 index 5d900b69f58c..000000000000 --- a/docs/deploying-airbyte/on-cloud.md +++ /dev/null @@ -1,21 +0,0 @@ -# On Airbyte Cloud - -## Overview - -Airbyte Cloud requires no setup and can be immediately run from your web browser. - -## Setup Guide - -**1. Using the Airbyte Cloud invite link provided to you, click `Sign up`, and verify your email.** - -**2. Click on the default workspace.** - -You will be provided 1000 credits to get your first few syncs going! - -![](../.gitbook/assets/cloud_onboarding.png) - -**3. Click on `Onboarding` and follow the directions to create your first connection. Or if you know what you're doing, just get started!** - -![](../.gitbook/assets/cloud_connection_onboarding.png) - -**4. You're done!** diff --git a/docs/deploying-airbyte/on-digitalocean-droplet.md b/docs/deploying-airbyte/on-digitalocean-droplet.md deleted file mode 100644 index c6bf49487e93..000000000000 --- a/docs/deploying-airbyte/on-digitalocean-droplet.md +++ /dev/null @@ -1,55 +0,0 @@ -# Deploy Airbyte on DigitalOcean - -This page guides you through deploying Airbyte Open Source on a [DigitalOcean droplet](https://docs.digitalocean.com/products/droplets/how-to/create/) by setting up the deployment environment, and installing and starting Airbyte. - -Alternatively, you can deploy Airbyte on DigitalOcean in one click using their [marketplace](https://cloud.digitalocean.com/droplets/new?onboarding_origin=marketplace&appId=95451155&image=airbyte&utm_source=deploying-airbyte_on-digitalocean-droplet). - -## Requirements - -- To test Airbyte, we recommend a $20/month droplet -- To deploy Airbyte in a production environment, we recommend a $40/month instance - -## Set up the Environment - -To deploy Airbyte Open Source on DigitalOcean: - -1. [Create a DigitalOcean droplet](https://docs.digitalocean.com/products/droplets/how-to/create/). -2. Connect to the droplet using the [Droplet Console](https://www.google.com/url?q=https://docs.digitalocean.com/products/droplets/how-to/connect-with-console/&sa=D&source=docs&ust=1666280581103312&usg=AOvVaw1hyEPyjRsmsRdIgbxZdu6F). -3. To update the available packages and install Docker, run the following command: - -```bash - sudo apt update - sudo apt install apt-transport-https ca-certificates curl software-properties-common - curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - - sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable" - sudo apt install docker-ce - sudo systemctl status docker - sudo usermod -aG docker ${USER} - su - ${USER} -``` - -4. To install Docker-Compose, run the following command: - -```bash - sudo apt install docker-compose-plugin - docker compose version -``` - -## Install Airbyte - -To install and start Airbyte : - -1. Run the following command: - -```bash - mkdir airbyte && cd airbyte - wget https://raw.githubusercontent.com/airbytehq/airbyte/master/run-ab-platform.sh - chmod +x run-ab-platform.sh - ./run-ab-platform.sh -b -``` - -2. Verify the connection by visiting [http://localhost:8000](http://localhost:8000) in your browser. - -## Troubleshooting - -If you encounter any issues, reach out to our community on [Slack](https://slack.airbyte.com/). diff --git a/docs/deploying-airbyte/on-gcp-compute-engine.md b/docs/deploying-airbyte/on-gcp-compute-engine.md deleted file mode 100644 index 6d278724c12b..000000000000 --- a/docs/deploying-airbyte/on-gcp-compute-engine.md +++ /dev/null @@ -1,107 +0,0 @@ -# Deploy Airbyte on GCP (Compute Engine) - -This page guides you through deploying Airbyte Open Source on a [Google Cloud Platform (GCP) Compute Engine instance](https://cloud.google.com/compute/docs/instances) by setting up the deployment environment, installing and starting Airbyte, and connecting it to the GCP instance. - -:::info - -The instructions have been tested on a `Debian GNU/Linux 10` VM instance. - -::: - -## Requirements - -- To test Airbyte, we recommend an `e2.medium` instance and provision at least 30GBs of disk per node -- To deploy Airbyte in a production environment, we recommend a `n1-standard-2` instance - -## Set up the environment - -1. Create a [new GCP instance](https://cloud.google.com/compute/docs/instances/create-start-instance). -2. Set variables in your local terminal: - -```bash -PROJECT_ID=PROJECT_ID_WHERE_YOU_CREATED_YOUR_INSTANCE -INSTANCE_NAME=airbyte # or any other name that you've used -``` - -3. Install Google Cloud SDK and initialize the gcloud command-line tool using the following commands in your local terminal: - -```bash -brew install --cask google-cloud-sdk -gcloud init -``` - -4. List all instances in your project and verify that you can see the Airbyte instance you created in step 1 in your local terminal: - -```bash -# Verify you can see your instance -gcloud --project $PROJECT_ID compute instances list -[...] # You should see the airbyte instance you just created -``` - -5. Connect to your instance in your local terminal: - -```bash -gcloud --project=$PROJECT_ID beta compute ssh $INSTANCE_NAME -``` - -6. Install Docker on your VM instance by following the below commands in your VM terminal: - -```bash -sudo apt-get update -sudo apt-get install -y apt-transport-https ca-certificates curl gnupg2 software-properties-common -curl -fsSL https://download.docker.com/linux/debian/gpg | sudo apt-key add -- -sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/debian buster stable" -sudo apt-get update -sudo apt-get install -y docker-ce docker-ce-cli containerd.io -sudo usermod -a -G docker $USER -``` - -7. Install `docker-compose` on your VM instance by following the below commands in your VM terminal: - -```bash -sudo apt-get -y install docker-compose-plugin -docker compose version -``` - -8. Close the SSH connection on your VM instance to ensure the group modification is taken into account by following the below command in your VM terminal: - -```bash -logout -``` - -## Install and launch Airbyte - -To install and launch Airbyte: - -1. In your local terminal, connect to your Google Cloud instance: - -```bash -gcloud --project=$PROJECT_ID beta compute ssh $INSTANCE_NAME -``` - -2. In your VM terminal, install Airbyte: - -```bash -mkdir airbyte && cd airbyte -wget https://raw.githubusercontent.com/airbytehq/airbyte/master/run-ab-platform.sh -chmod +x run-ab-platform.sh -./run-ab-platform.sh -b -``` - -## Connect to Airbyte - -:::caution -For security reasons, we strongly recommended not exposing Airbyte publicly. -::: - -1. In your local terminal, create an SSH tunnel to connect the GCP instance to Airbyte: - -```bash -gcloud --project=$PROJECT_ID beta compute ssh $INSTANCE_NAME -- -L 8000:localhost:8000 -N -f -``` - -2. Verify the connection by visiting [http://localhost:8000](http://localhost:8000) in your browser. - -## Troubleshooting - -If you encounter any issues, reach out to our community on [Slack](https://slack.airbyte.com/). diff --git a/docs/deploying-airbyte/on-kubernetes-via-helm.md b/docs/deploying-airbyte/on-kubernetes-via-helm.md deleted file mode 100644 index cff290b8922c..000000000000 --- a/docs/deploying-airbyte/on-kubernetes-via-helm.md +++ /dev/null @@ -1,625 +0,0 @@ -# Deploy Airbyte on Kubernetes using Helm - -## Overview - -Airbyte allows scaling sync workloads horizontally using Kubernetes. The core components \(api -server, worker, etc\) run as deployments while the scheduler launches connector-related pods on -different nodes. - -## Quickstart - -If you don't want to configure your own Kubernetes cluster and Airbyte instance, you can use the -free, open-source project [Plural](https://www.plural.sh/) to bring up a Kubernetes cluster and -Airbyte for you. Use [this guide](on-plural.md) to get started. - -Alternatively, you can deploy Airbyte on [Restack](https://www.restack.io) to provision your -Kubernetes cluster on AWS. Follow [this guide](on-restack.md) to get started. - -:::note - -Airbyte Kubernetes Community Edition does not support basic auth by default. To enable basic auth, -consider adding a reverse proxy in front of Airbyte. - -::: - -## Getting Started - -### Cluster Setup - -For local testing we recommend following one of the following setup guides: - -- [Docker Desktop \(Mac\)](https://docs.docker.com/desktop/kubernetes) -- [Minikube](https://minikube.sigs.k8s.io/docs/start) - - NOTE: Start Minikube with at least 4gb RAM with `minikube start --memory=4000` -- [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/) - -For testing on GKE you can -[create a cluster with the command line or the Cloud Console UI](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-zonal-cluster). - -For testing on EKS you can [install eksctl](https://eksctl.io/introduction/) and run -`eksctl create cluster` to create an EKS cluster/VPC/subnets/etc. This process should take 10-15 -minutes. - -For production, Airbyte should function on most clusters v1.19 and above. We have tested support on -GKE and EKS. If you run into a problem starting Airbyte, please reach out on the `#troubleshooting` -channel on our [Slack](https://slack.airbyte.io/) or -[create an issue on GitHub](https://github.com/airbytehq/airbyte/issues/new?assignees=&labels=type%2Fbug&template=bug-report.md&title=). - -### Install `kubectl` - -If you do not already have the CLI tool `kubectl` installed, please follow -[these instructions to install](https://kubernetes.io/docs/tasks/tools/). - -### Configure `kubectl` - -Configure `kubectl` to connect to your cluster by using `kubectl use-context my-cluster-name`. - -For GKE: - -1. Configure `gcloud` with `gcloud auth login`. -2. On the Google Cloud Console, the cluster page will have a `Connect` button, which will give a - command to run locally that looks like - - `gcloud container clusters get-credentials $CLUSTER_NAME --zone $ZONE_NAME --project $PROJECT_NAME`. - -3. Use `kubectl config get-contexts` to show the contexts available. -4. Run `kubectl config use-context $GKE_CONTEXT` to access the cluster from `kubectl`. - -For EKS: - -1. [Configure your AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) - to connect to your project. -2. Install [eksctl](https://eksctl.io/introduction/) -3. Run `eksctl utils write-kubeconfig --cluster=` to make the context available to - `kubectl` -4. Use `kubectl config get-contexts` to show the contexts available. -5. Run `kubectl config use-context ` to access the cluster with `kubectl`. - -### Install helm - -To install helm simply run: - -For MacOS: - -`brew install helm` - -For Linux: - -1. Download installer script - `curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3` -2. Assign required premissions `chmod 700 get_helm.sh` -3. Run script `./get_helm.sh` - -### Add Helm Repository - -From now charts are stored in helm-repo thus there're no need to clone the repo each time you need -to deploy the chart. - -To add remote helm repo simply run: `helm repo add airbyte https://airbytehq.github.io/helm-charts`. - -Where `airbyte` is the name of the repository that will be indexed locally. - -After adding the repo, perform the repo indexing process by running `helm repo update`. - -After this you can browse all charts uploaded to repository by running `helm search repo airbyte` - -It'll produce output similar to below: - -```text -NAME CHART VERSION APP VERSION DESCRIPTION -airbyte/airbyte 0.49.9 0.50.33 Helm chart to deploy airbyte -airbyte/airbyte-api-server 0.49.9 0.50.33 Helm chart to deploy airbyte-api-server -airbyte/airbyte-bootloader 0.49.9 0.50.33 Helm chart to deploy airbyte-bootloader -airbyte/connector-builder-server 0.49.9 0.50.33 Helm chart to deploy airbyte-connector-builder-... -airbyte/cron 0.49.9 0.50.33 Helm chart to deploy airbyte-cron -airbyte/metrics 0.49.9 0.50.33 Helm chart to deploy airbyte-metrics -airbyte/pod-sweeper 0.49.9 0.50.33 Helm chart to deploy airbyte-pod-sweeper -airbyte/server 0.49.9 0.50.33 Helm chart to deploy airbyte-server -airbyte/temporal 0.49.9 0.50.33 Helm chart to deploy airbyte-temporal -airbyte/webapp 0.49.9 0.50.33 Helm chart to deploy airbyte-webapp -airbyte/worker 0.49.9 0.50.33 Helm chart to deploy airbyte-worker -``` - -## Deploy Airbyte - -### Default deployment - -If you don't intend to customise your deployment, you can deploy airbyte as is with default values. - -In order to do so, run the command: - -``` -helm install %release_name% airbyte/airbyte -``` - -**Note**: `release_name` should only contain lowercase letters and optionally dashes (`release_name` -must start with a letter). - -### Custom deployment - -In order to customize your deployment, you need to create `values.yaml` file in the local folder and -populate it with default configuration override values. - -`values.yaml` example can be located in -[charts/airbyte](https://github.com/airbytehq/airbyte-platform/blob/main/charts/airbyte/values.yaml) -folder of the Airbyte repository. - -After specifying your own configuration, run the following command: - -```text -helm install --values path/to/values.yaml %release_name% airbyte/airbyte -``` - -### External Logs with S3 - -:::info - -S3 logging was tested on -[Airbyte Helm Chart Version 0.50.13](https://artifacthub.io/packages/helm/airbyte/airbyte/0.50.13) - -::: - -Create a file called `airbyte-logs-secrets.yaml` to store the AWS Keys and other informations: - -```yaml -apiVersion: v1 -kind: Secret -metadata: - name: airbyte-logs-secrets -type: Opaque -stringData: - AWS_KEY: - AWS_SECRET_KEY: - S3_LOG_BUCKET: - S3_LOG_BUCKET_REGION: -``` - -Run `kubectl apply -f airbyte-logs-secrets.yaml -n ` to create the secret in the -namespace you're using Airbyte. This file contains more than just the keys but it needs for now. -Future updates will make the configuration easier. - -Change the global section to use `S3` external logs. - -```yaml -global: - # <...> - state: - # -- Determines which state storage will be utilized; "MINIO", "S3", or "GCS" - storage: - type: "S3" - # <...> - logs: - accessKey: - password: "" - existingSecret: "airbyte-logs-secrets" - existingSecretKey: "AWS_KEY" - secretKey: - password: "" - existingSecret: "airbyte-logs-secrets" - existingSecretKey: "AWS_SECRET_KEY" - # <...> - storage: - type: "S3" - - minio: - # Change from true to false - enabled: false - nodeSelector: {} - tolerations: [] - affinity: {} -``` - -Amazon S3 Logging information is below but you can try to use `External Minio` as well but it was not -tested yet. Feel free to run tests and update the documentation. - -Add extra env variables to the following blocks: - -```yaml -worker: - extraEnv: - - name: AWS_ACCESS_KEY_ID - valueFrom: - secretKeyRef: - name: airbyte-logs-secrets - key: AWS_KEY - - name: AWS_SECRET_ACCESS_KEY - valueFrom: - secretKeyRef: - name: airbyte-logs-secrets - key: AWS_SECRET_KEY - - name: STATE_STORAGE_S3_ACCESS_KEY - valueFrom: - secretKeyRef: - name: airbyte-logs-secrets - key: AWS_KEY - - name: STATE_STORAGE_S3_SECRET_ACCESS_KEY - valueFrom: - secretKeyRef: - name: airbyte-logs-secrets - key: AWS_SECRET_KEY - - name: STATE_STORAGE_S3_BUCKET_NAME - valueFrom: - secretKeyRef: - name: airbyte-logs-secrets - key: S3_LOG_BUCKET - - name: STATE_STORAGE_S3_REGION - valueFrom: - secretKeyRef: - name: airbyte-logs-secrets - key: S3_LOG_BUCKET_REGION -``` - -and also edit the server block: - -```yaml -server: - extraEnv: - - name: AWS_ACCESS_KEY_ID - valueFrom: - secretKeyRef: - name: airbyte-logs-secrets - key: AWS_KEY - - name: AWS_SECRET_ACCESS_KEY - valueFrom: - secretKeyRef: - name: airbyte-logs-secrets - key: AWS_SECRET_KEY - - name: STATE_STORAGE_S3_ACCESS_KEY - valueFrom: - secretKeyRef: - name: airbyte-logs-secrets - key: AWS_KEY - - name: STATE_STORAGE_S3_SECRET_ACCESS_KEY - valueFrom: - secretKeyRef: - name: airbyte-logs-secrets - key: AWS_SECRET_KEY - - name: STATE_STORAGE_S3_BUCKET_NAME - valueFrom: - secretKeyRef: - name: airbyte-logs-secrets - key: S3_LOG_BUCKET - - name: STATE_STORAGE_S3_REGION - valueFrom: - secretKeyRef: - name: airbyte-logs-secrets - key: S3_LOG_BUCKET_REGION -``` - -Than run: -`helm upgrade --install %RELEASE_NAME% airbyte/airbyte -n --values /path/to/values.yaml --version 0.50.13` - -### External Logs with GCS - -:::info - -GCS Logging is similar to the approach taken for S3 above, with a few small differences -GCS logging was tested on [Airbyte Helm Chart Version 0.54.69](https://artifacthub.io/packages/helm/airbyte/airbyte/0.54.69) - -::: - -#### Create Google Cloud Storage Bucket - -1. **Access Google Cloud Console**: Go to the Google Cloud Console and select or create a project - where you want to create the bucket. -2. **Open Cloud Storage**: Navigate to "Storage" > "Browser" in the left-side menu. -3. **Create Bucket**: Click on "Create bucket". Give your bucket a unique name, select a region for the bucket, and configure other settings such as storage class and access control according to your requirements. Finally, click "Create". The buckect will be referenced as `` - -#### Create Google Cloud Service Account - -1. **Open IAM & Admin**: In the Cloud Console, navigate to "IAM & Admin" > "Service Accounts". -2. **Create Service Account**: Click "Create Service Account", enter a name, description, and then click "Create". -3. **Grant Permissions**: Assign the role of "Storage Object Admin" to the service account by selecting it from the role list. -4. **Create Key**: After creating the service account, click on it, go to the "Keys" tab, and then click "Add Key" > "Create new key". Choose JSON as the key type and click "Create". The key file will be downloaded automatically to your computer. -5. **Encode Key**: Encode GCP credentials file contents using Base64. This key will be referenced as `` - -#### Update the values.yaml with the GCS Logging Information below - -Update the following Environment Variables in the global section: - -``` -global: - state: - storage: - type: "GCS" - - logs: - storage: - type: "GCS" - gcs: - bucket: "" - credentials: "/secrets/gcs-log-creds/gcp.json" - credentialsJson: "" -``` - -Update the following Environment Variables in the worker section: - -``` -worker: - - extraEnv: - - name: STATE_STORAGE_GCS_BUCKET_NAME - value: - - name: STATE_STORAGE_GCS_APPLICATION_CREDENTIALS - value: /secrets/gcs-log-creds/gcp.json - - name: CONTAINER_ORCHESTRATOR_SECRET_NAME - value: <%RELEASE_NAME%>-gcs-log-creds - - name: CONTAINER_ORCHESTRATOR_SECRET_MOUNT_PATH - value: /secrets/gcs-log-creds -``` - -Then run: -`helm upgrade --install %RELEASE_NAME% airbyte/airbyte -n --values /path/to/values.yaml --version 0.54.69` - -### External Airbyte Database - -:::info - -This was tested using -[Airbyte Helm Chart Version 0.50.13](https://artifacthub.io/packages/helm/airbyte/airbyte/0.50.13). -Previous or newer version can change how the external database can be configured. - -::: - -The Airbyte Database only works with Postgres 13. Make sure the database is accessible inside the -cluster using `busy-box` service using `telnet` or `ping` command. - -:::warning - -If you're using the external database for the first time you must ensure the database you're going -to use exists. The default database Airbyte will try to use is `airbyte` but you can modified it in -the `values.yaml`. - -::: - -:::warning - -You can use only one database to a one Airbyte Helm deployment. If you try to use the same database -for a different deployment it will have conflict with Temporal internal databases. - -::: - -Create a Kubernetes secret to store the database password. Save the file as `db-secrets.yaml`. - -```yaml -apiVersion: v1 -kind: Secret -metadata: - name: db-secrets -type: Opaque -stringData: - DATABASE_PASSWORD: -``` - -Run `kubectl apply -f db-secrets.yaml -n ` to create the secret in the namespace you're -using Airbyte. - -Afterward, modify the following blocks in the Helm Chart `values.yaml` file: - -```yaml -postgresql: - # Change the value from true to false. - enabled: false -``` - -Then: - -```yaml -externalDatabase: - # Add the host, username and database name you're using. - host: - user: - database: - password: "" - existingSecret: "db-secrets" - existingSecretPasswordKey: "DATABASE_PASSWORD" - port: 5432 - jdbcUrl: "" -``` - -Keep password empty as the Chart will use the `db-secrets` value. Edit only the host, username, and -database name. If your database is using a differnet `port` or need an special `jdbcUrl` you can -edit here. This wasn't fully tested yet. - -Next, reference the secret in the global section: - -```yaml -global: - database: - secretName: "db-secrets" - secretValue: "DATABASE_PASSWORD" -``` - -Unfortunately, the `airbyte-bootloader` configuration uses this variable. Future improvements are -planned. - -Upgrade the chart by running: - -```shell -helm upgrade --install %RELEASE_NAME% airbyte/airbyte -n --values /path/to/values.yaml --version 0.50.13 -``` - -## Migrate from old chart to Airbyte v0.52.0 and latest chart version - -To assist with upgrading to Airbyte App version 0.52.0 and higher with the latest Helm Charts, we've -simplified and consolidated several configuration options. Here's a breakdown of the changes: - -**Application.yaml Updates**: - -- We've streamlined the configuration for logs and state storage. -- Instead of separate configurations for logs and state, we now have a unified storage - configuration. -- The proposed changes involve specifying the storage type and bucket names directly, along with - credentials where necessary. - -**Helm Configuration Updates:** - -- The global configuration now includes a simplified storage section specifying the type and bucket - names for logs, state, and workload output. -- Credentials for MinIO are now set directly in the Helm values, ensuring smoother integration. -- Unused configurations have been removed, and configurations have been aligned with the simplified - application.yaml. - -**Technical Details and Renaming:** - -- We've renamed or consolidated several environment variables for clarity and consistency. -- Unused methods and classes have been removed, ensuring a cleaner codebase. -- Some configurations have been split into separate files for better management and compatibility - with different storage options. - -**Additional Changes:** - -- We've added support for workload output storage explicitly, improving flexibility and clarity in - configuration. -- The Helm charts have been updated to reflect these changes, removing or replacing old environment - variables for storage configuration. -- These changes aim to simplify configuration management and improve the overall user experience - during upgrades. Please review these updates and let us know if you have any questions or need - further assistance. - -### **Migration Steps** - -This guide aims to assist customers upgrading to the latest version of the Airbyte Helm charts, -specifically those using custom configurations for external logging and databases with AWS (S3) and -GCS (Google Cloud Buckets). - -### **For AWS S3 Users** - -#### **Prerequisites** - -- Access to your Kubernetes cluster where Airbyte is deployed. -- Helm and kubectl installed and configured on your machine. -- Existing Airbyte deployment using AWS S3 for storage and AWS Secrets Manager for secret - management. - -#### **Migration Steps** - -1. **Creating or Updating Kubernetes Secrets** - -If using AWS access keys, create a Kubernetes secret to store these credentials. If relying on an -IAM role from an instance profile, this step can be skipped. Apply the following Kubernetes -manifest, replacing the example AWS credentials with your actual credentials: - -```yaml -# Replace the example AWS credentials below with your actual credentials. -apiVersion: v1 -kind: Secret -metadata: - name: airbyte-config-secrets -type: Opaque -stringData: - s3-access-key-id: AKIAIOSFODNN7EXAMPLE # Enter your AWS Access Key ID here - s3-secret-access-key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY # Enter your AWS Secret Access Key here -``` - -2. **Update Airbyte Configuration** - - In your `airbyte.yml` configuration file, add the following configuration, adjusting - `` to match your AWS region: - - ```yaml - global: - storage: - type: s3 - storageSecretName: airbyte-config-secrets - bucket: - log: airbyte-storage - state: airbyte-storage - workloadOutput: airbyte-storage - s3: - region: - authenticationType: credentials # Use "credentials" or "instanceProfile" - accessKeyIdSecretKey: aws-secret-manager-access-key-id # Omit if using instanceProfile - secretAccessKeySecretKey: aws-secret-manager-secret-access-key # Omit if using instanceProfile - - secretsManager: - type: awsSecretManager - storageSecretName: airbyte-config-secrets - awsSecretManager: - region: - authenticationType: credentials # Use "credentials" or "instanceProfile" - accessKeyIdSecretKey: aws-secret-manager-access-key-id # Omit if using instanceProfile - secretAccessKeySecretKey: aws-secret-manager-secret-access-key # Omit if using instanceProfile - tags: - - key: team - value: deployment - - key: business-unit - value: engineering - ``` - -3. **Remove Deprecated Configuration from `values.yaml`** - - Edit your `values.yaml` or `airbyte-pro-values.yaml` files to remove any deprecated storage and - secrets manager environment variables related to S3 and AWS Secrets Manager. Ensure - configurations like `state.storage.type: "S3"` and AWS access keys under `server.extraEnv` and - `worker.extraEnv` are removed. - -### **For GCS Users** - -#### **Prerequisites** - -- Access to your Kubernetes cluster where Airbyte is deployed. -- Helm and kubectl installed and configured on your machine. -- Existing Airbyte deployment using Google Cloud Storage (GCS) and Google Secret Manager (GSM) for - secret management. - -#### **Migration Steps** - -1. **Setting Up or Updating Kubernetes Secrets** - - For Google Secret Manager, you may use existing credentials or create new ones. Apply a - Kubernetes manifest like below, replacing `` with your GCP credentials - JSON blob: - - ```yaml - apiVersion: v1 - kind: Secret - metadata: - name: gcp-cred-secrets - type: Opaque - stringData: - gcp.json: - ``` - - Or use `kubectl` to create the secret directly from a file: - - ```sh - kubectl create secret generic gcp-cred-secrets --from-file=gcp.json=.json - ``` - -2. **Update Airbyte Configuration** - - In your `airbyte.yml` configuration file, add the following configuration, adjusting - `` to match your GCP project ID: - - ```yaml - global: - storage: - type: gcs - storageSecretName: gcp-cred-secrets - bucket: - log: airbyte-storage - state: airbyte-storage - workloadOutput: airbyte-storage - gcs: - authenticationType: credentials - projectId: - credentialsPath: /secrets/gcs-log-creds/gcp.json - - secretsManager: - type: googleSecretManager - storageSecretName: gcp-cred-secrets - googleSecretManager: - authenticationType: credentials - projectId: - credentialsSecretKey: gcp-creds.json - ``` - -3. **Remove Deprecated Configuration from `values.yaml`** - - Edit your `values.yaml` files to remove any deprecated storage and secrets manager environment - variables related to GCS. Ensure configurations like `global.state.storage.type: "GCS"` and GCS - credentials paths under `extraEnv` are removed. - -This guide ensures that you leverage the latest Helm chart configurations for Airbyte, aligning with -best practices for managing storage and secrets in Kubernetes environments for AWS and GCS users. diff --git a/docs/deploying-airbyte/on-oci-vm.md b/docs/deploying-airbyte/on-oci-vm.md deleted file mode 100644 index c775ffb24478..000000000000 --- a/docs/deploying-airbyte/on-oci-vm.md +++ /dev/null @@ -1,87 +0,0 @@ -# Deploy Airbyte on Oracle Cloud - -This page guides you through deploying Airbyte Open Source on an [Oracle Cloud Infrastructure (OCI) Virtual Machine (VM) Instance](https://docs.oracle.com/en-us/iaas/Content/Compute/Tasks/launchinginstance.htm#Creating_an_Instance). - -:::info - -These instructions have been tested on an Oracle Linux 7 instance. - -::: - -## Prerequisites - -To deploy Airbyte Open Source on Oracle cloud: - -- Create an [OCI VM compute instance](https://docs.oracle.com/en-us/iaas/Content/Compute/Tasks/launchinginstance.htm#Creating_an_Instance) -- Allowlist a port for a CIDR range in the [security list of your OCI VM Instance subnet](https://docs.oracle.com/en-us/iaas/Content/Network/Concepts/securitylists.htm) -- Connect to the instance using a [bastion port forwarding session](https://docs.oracle.com/en-us/iaas/Content/Bastion/Tasks/connectingtosessions.htm#connect-port-forwarding) - -:::caution - -For security reasons, we strongly recommend not having a Public IP for the Instance where you are running Airbyte. - -::: - -## Set up the environment - -Install Docker and Docker Compose on the VM: - -1. Install Docker - -In the terminal connected to your OCI Instance for Airbyte, run the following commands: - -```bash -sudo yum update -y - -sudo yum install -y docker - -sudo service docker start - -sudo usermod -a -G docker $USER -``` - -2. Install Docker Compose - -In the terminal connected to your OCI Instance for Airbyte, run the following commands: - -```bash -sudo yum install -y docker-compose-plugin - -docker compose version -``` - -## Install and start Airbyte - -Download the Airbyte repository and deploy it on the VM: - -1. Run the following commands to download the Airbyte installation script: - - ```bash - mkdir airbyte && cd airbyte - wget https://raw.githubusercontent.com/airbytehq/airbyte/master/run-ab-platform.sh - chmod +x run-ab-platform.sh -b - ``` - -2. Run the following command to get Airbyte running on your OCI VM instance using the installation script: - - ```bash - ./run-ab-platform.sh -b - ``` - -3. Open up a Browser and visit port 8000 - [http://localhost:8000/](http://localhost:8000/) - -Alternatively, you can get Airbyte running on your OCI VM instance using a different approach. - -1. In the terminal connected to your OCI Instance for Airbyte, run the command: - - ```bash - ssh opc@bastion-host-public-ip -i -L 8000:oci-private-instance-ip:8000 - ``` - - Replace `` with the path to your private key. - -2. On your browser, visit port 8000 [port 8000](http://localhost:8000/) - -## Troubleshooting - -If you encounter any issues, reach out to our community on [Slack](https://slack.airbyte.com/). diff --git a/docs/deploying-airbyte/on-plural.md b/docs/deploying-airbyte/on-plural.md deleted file mode 100644 index 5662544ee720..000000000000 --- a/docs/deploying-airbyte/on-plural.md +++ /dev/null @@ -1,90 +0,0 @@ -# Deploy Airbyte on Plural - -:::tip -If you'd prefer to follow along with a video, check out the Plural Airbyte deployment guide video [here](https://youtu.be/suvTJyJ6PzI) -::: - -## Getting started - -1. Create an account on [https://app.plural.sh](https://app.plural.sh). -2. Install the Plural CLI by following steps 1, 2, and 3 of the instructions [here](https://docs.plural.sh/getting-started). Through this, you will also configure your cloud provider and the domain name under which your application will be deployed to. - -We now need a Git repository to store your Plural configuration in. This will also contain the Helm and Terraform files that Plural will autogenerate for you. - -You have two options: - -- Run `plural init` in any directory to let Plural initiate an OAuth workflow to create a Git repo for you. -- Create a Git repo manually, clone it, and run `plural init` inside it. - -Running `plural init` will configure your installation and cloud provider for the repo. - -## Installing Airbyte - -To install Airbyte on your Plural repo, run: - -```bash -plural bundle install airbyte $CONSOLE_BUNDLE_NAME -``` - -To find the console bundle name for your cloud provider, run: - -```bash -plural bundle list airbyte -``` - -For example, this is what it looks like for AWS: - -```bash -plural bundle install airbyte airbyte-aws -``` - -Plural's Airbyte distribution currently has support for AWS, GCP and Azure. Select the Cloud that best fits your infrastructure. - -The CLI prompts you to choose whether or not you want to use Plural OIDC. [OIDC](https://openid.net/connect/) allows you to login to the applications you host on Plural with your login to [app.plural.sh](https://app.plural.sh), acting as an SSO provider. - -After this, run: - -```bash -plural build -plural deploy --commit "deploying airbyte" -``` - -## Adding the Plural Console - -To make management of your installation as simple as possible, we recommend installing the Plural Console. The console provides tools to manage resource scaling, receiving automated upgrades, dashboards tailored to your Airbyte installation, and log aggregation. Run: - -```bash -plural bundle install console console-aws -plural build -plural deploy --commit "deploying the console too" -``` - -## Accessing your Airbyte Installation - -Navigate to `airbyte.SUBDOMAIN_NAME.onplural.sh` to access the Airbyte UI. - -## Accessing your Console Installation - -To monitor and manage your Airbyte installation, navigate to the Plural Console at `console.YOUR_ORGANIZATION.onplural.sh` (or whichever subdomain you chose). - -## Advanced Use Cases - -### Running with External Airflow - -If you have an Airflow instance external to the Plural Kubernetes cluster with your Airbyte installation, you can still have Airflow manage the Airbyte installation. This happens because Basic Auth setup is required for external authentication - Plural OIDC is not sufficient here. - -In your `context.yaml` file located at the root of your Plural installation, create a user with Basic Auth for Airbyte. Then on your Airbyte Airflow connector, use the following URL template: - -``` -https://username:password@airbytedomain -``` - -## Troubleshooting - -If you have any issues with installing Airbyte on Plural, join Plural's [Discord Community](https://discord.gg/bEBAMXV64s). - -If you'd like to request any new features for our Airbyte installation, open an issue or PR at https://github.com/pluralsh/plural-artifacts. - -## Further Reading - -To learn more about Plural, refer to the [Plural documentation](https://docs.plural.sh) diff --git a/docs/deploying-airbyte/on-restack.md b/docs/deploying-airbyte/on-restack.md deleted file mode 100644 index 3bf4d0800e37..000000000000 --- a/docs/deploying-airbyte/on-restack.md +++ /dev/null @@ -1,67 +0,0 @@ -# On Restack - -## Getting Started - -To deploy Airbyte with Restack: - -- [Sign up for a Restack account](#sign-up-for-a-restack-account). -- [Add AWS credentials with AdministratorAccess](#add-aws-credentials-with-administratoraccess). -- [One-click cluster creation with Restack](#one-click-cluster-creation-with-restack). -- [Deploy Airbyte on Restack](#deploy-airbyte-on-restack). -- [Start using Airbyte](#start-using-airbyte). -- [Deploy multiple instances of Airbyte](#deploy-multiple-instances-of-airbyte). - -## Sign up for a Restack account - -To Sign up for a Restack account, visit [www.restack.io/signup](https://www.restack.io/signup). You can sign up with your corporate email address or your GitHub profile. You do not need a credit card to sign up. -If you already have an account, login to Restack at [www.restack.io/login](https://www.restack.io/login). - -## Add AWS credentials with AdministratorAccess - -To deploy Airbyte in your own AWS infrastructure with Restack, you will need to add your credentials as the next step. - -Make sure that this account has _AdministratorAccess_. This is how Restack can ensure an end-to-end cluster creation and cluster management process. - -1. Navigate to **Clusters** in the left-hand navigation menu. -2. Select the **Credentials** tab. -3. Click **Add credential**. -4. Give a suitable title to your credentials for managing them later. -5. Enter your [**AWS Access Key ID** and **AWS Secret Access key**.](https://docs.aws.amazon.com/accounts/latest/reference/root-user-access-key.html) -6. Click **Add credential**. - -## One-click cluster creation with Restack - -:::tip -Running your application on a Kubernetes cluster lets you deploy, scale and monitor the application reliably. -::: - -Once you have added your credentials: - -1. Navigate to the **Clusters** tab on the same page and click on **Create cluster**. -2. Give a suitable name to your cluster. -3. Select the region you want to deploy the cluster in. -4. Select the AWS credentials you added in the previous step. - -The cluster creation process will start automatically. Once the cluster is ready, you will get an email on the email id connected with your account. - -Creating a cluster is a one-time process. From here you can add other open source tools or multiple instances of Airbyte in the same cluster. - -Any application you deploy in your cluster will be accessible via a free **restack domain**. -Contact the Restack team via chat to set a custom domain for your Airbyte instances. - -## Deploy Airbyte on Restack - -1. Click **Add application** from the Cluster description or go to the Applications tab in the left hand side navigation. -2. Click **Airbyte**. -3. Select the cluster you have already provisioned. -4. Click **Add application**. - -## Start using Airbyte - -Airbyte will be deployed on your cluster and you can access it using the link under the _URL_ tab. -You can also check the workloads and volumes that are deployed within Airbyte. - -## Deploy multiple instances of Airbyte - -Restack makes it easier to deploy multiple instances of Airbyte on the same or multiple clusters. -
So you can test the latest version before upgrading or have a dedicated instance for development and for production. diff --git a/docs/integrations/sources/gridly.md b/docs/integrations/sources/gridly.md index 66954d57cbfb..3ffa3c6fa4a3 100644 --- a/docs/integrations/sources/gridly.md +++ b/docs/integrations/sources/gridly.md @@ -4,22 +4,21 @@ This page contains the setup guide and reference information for the Gridly sour ## Prerequisites -A Gridly account. +- Access to an active Gridly account +- API Key (requires Owner or Administrator access) ## Setup guide -### Get api Key +### Find your API Key -1. To quickly get your API key, access your Gridly Dashboard, then select a Grid View and you can find the key in API quick start right panel. - ![img.png](../../.gitbook/assets/gridly_api_key1.png) -2. Owner and Administrators can go to Settings/API keys to create company-level API keys with scoped privileges and accesses. - ![img.png](../../.gitbook/assets/gridly_api_key2.png) +1. Access your Gridly Dashboard +2. Select **[API]**. The API key will be shown in the API Quickstart panel. +2. Owner and Administrators can also go to their **Settings** and then **API Keys** to create company-level API keys with scoped privileges and accesses. -### Get grid id +### Find the Grid ID -The grid id is available in the url. -Gridly support version control, by default the `grid id` is the same to the `branch id` when `Master` branch is selected. For fetching records on other branches, use `branch id` instead. -![img.png](../../.gitbook/assets/gridly_grid_id.png) +1. `Grid ID` is available in the URL when accessing the Grid in the UI. The Grid ID is the ID following `/grids/` in the URL. +2. `Branch ID` is by default the same as the `Grid ID` when the `Master` branch is selected. To fetch records on other branches, use `Branch ID` instead. ## Supported sync modes diff --git a/docs/integrations/sources/slack.md b/docs/integrations/sources/slack.md index c6536fd46025..b3c0a8aecd29 100644 --- a/docs/integrations/sources/slack.md +++ b/docs/integrations/sources/slack.md @@ -8,72 +8,51 @@ This page contains the setup guide and reference information for the [Slack](htt ## Prerequisites -OAuth or API Token (via Slack App or Legacy API Key) is required for access to Slack. +Before you begin, have the following ready: -You can no longer create "Legacy" API Keys, but if you already have one, you can use it with this source. Fill it into the API key section. - -We recommend creating a restricted, read-only key specifically for Airbyte access. This will allow you to control which resources Airbyte should be able to access. - -Note that refresh token are entirely optional for Slack and are not required to use Airbyte. You can learn more about refresh tokens [here](https://api.slack.com/authentication/rotation). +- Administrator access to an active Slack Workspace +- Slack App OAuth (preferred) or API Key ## Setup guide ### Step 1: Set up Slack -:::info - -If you are using an "legacy" Slack API, skip to the Airbyte Open Source additional setup steps section below. - -::: - -In order to pull data out of your Slack instance, you need to create a Slack App. This may sound daunting, but it is actually pretty straight forward. Slack supplies [documentation](https://api.slack.com/start) on how to build apps. Feel free to follow that if you want to do something fancy. We'll describe the steps we followed to creat the Slack App for this tutorial. +The following instructions guide you through creating a Slack app. Airbyte can only replicate messages from channels that the app has been added to. :::info - -This tutorial assumes that you are an administrator on your slack instance. If you are not, you will need to coordinate with your administrator on the steps that require setting permissions for your app. - +If you are using a legacy Slack API Key, you can skip this section. ::: -1. Go to the [apps page](https://api.slack.com/apps) -2. Click "Create New App" -3. It will request a name and the slack instance you want to create the app for. Make sure you select the instance form which you want to pull data. -4. Completing that form will take you to the "Basic Information" page for your app. -5. Now we need to grant the correct permissions to the app. \(This is the part that requires you to be an administrator\). Go to "Permissions". Then under "Bot Token Scopes" click on "Add an OAuth Scope". We will now need to add the following scopes: - - ```text - channels:history - channels:join - channels:read - files:read - groups:read - links:read - reactions:read - remote_files:read - team:read - usergroups:read - users.profile:read - users:read - ``` - - This may look daunting, but the search functionality in the dropdown should make this part go pretty quick. - -6. Scroll to the top of the page and click "Install to Workspace". This will generate a "Bot User OAuth Access Token". We will need this in a moment. -7. Now go to your slack instance. For any public channel go to info => more => add apps. In the search bar search for the name of your app. \(If using the desktop version of slack, you may need to restart Slack for it to pick up the new app\). Airbyte will only replicate messages from channels that the Slack bot has been added to. - - ![](../../.gitbook/assets/slack-add-apps.png) - -8. In Airbyte, create a Slack source. The "Bot User OAuth Access Token" from the earlier should be used as the token. -9. You can now pull data from your slack instance! - - - -**Airbyte Open Source additional setup steps** - -You can no longer create "Legacy" API Keys, but if you already have one, you can use it with this source. Fill it into the API key section. - -We recommend creating a restricted, read-only key specifically for Airbyte access. This will allow you to control which resources Airbyte should be able to access. - - +To create a Slack App, read this [tutorial](https://api.slack.com/tutorials/tracks/getting-a-token) on how to create an app, or follow these instructions. + +1. Go to your [Apps](https://api.slack.com/apps) +2. Click **Create New App**. Select **From Scratch**. +3. Choose a name for your app and select the name of your Slack workspace. Click **Create App**. +4. In the navigation menu, select **OAuth & Permissions**. +5. Navigate to **Scopes**. In **Bot Token Scopes**, select the following scopes: + +``` + channels:history + channels:join + channels:read + files:read + groups:read + links:read + reactions:read + remote_files:read + team:read + usergroups:read + users:read + users.profile:read +``` + +6. At the top of the "OAuth & Permissions" page, click **Install to Workspace**. This will generate a Bot User OAuth Token. Copy this for later if you are using the API token for authentication. +7. Go to your Slack instance. For any public channel, go to **Info**, **More**, and select **Add Apps**. +8. Search for your newly created app. (If you are using the desktop version of Slack, you may need to restart Slack for it to pick up the new App). Add the App to all channels you want to sync data from. + +:::note +If you are using an API key to authenticate to Slack, a refresh token is not required, as acccess tokens never expire. You can learn more about refresh tokens [here](https://api.slack.com/authentication/rotation). +::: ### Step 2: Set up the Slack connector in Airbyte @@ -81,31 +60,42 @@ We recommend creating a restricted, read-only key specifically for Airbyte acces **For Airbyte Cloud:** -1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account. -2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**. -3. On the Set up the source page, enter the name for the Slack connector and select **Slack** from the Source type dropdown. -4. Select `Authenticate your account` and log in and Authorize to the Slack account. -5. **Required** Enter your `start_date`. -6. **Required** Enter your `lookback_window`, which corresponds to amount of days in the past from which you want to sync data. -7. Toggle `join_channels`, if you want to join all public channels or to sync data only from channels the bot is already in. If not set, you'll need to manually add the bot to all the channels from which you'd like to sync messages. -8. Enter your `channel_filter`, this should be list of channel names (without leading '#' char) that limits the channels from which you'd like to sync. If no channels are specified, Airbyte will replicate all data. -9. Toggle `include_private_channels` if you want to sync data from private channels. You will need to manually add the bot to private channels, `join_channel` does not work with private channels. -10. Click **Set up source**. +1. In the navigation bar, click **Sources**. +2. Click **New source**. +3. Find and click **Slack**. +4. Click **Authenticate your Slack account**. Log in and authorize Airbyte to access your Slack account. + +5. Toggle `join_channels`, if you want to join all public channels or to sync data only from channels the bot is already in. If not set, you'll need to manually add the bot to all the channels from which you'd like to sync messages. + + +6. **Start Date**: Any data before this date will not be extracted. + + +7. **Threads Lookback window (Days)**. This corresponds to the number of days in the past from which you want to sync data. + + +8. (Optional) **Channel filter** the list of channel names (without leading '#' char) that limits the channels from which you'd like to sync. If no channels are specified, Airbyte will replicate data from all channels. + + +9. (Optional) **Include_private_channels** Toggle on to sync data from private channels. You will need to manually add the bot to private channels even if `join_channels` is toggled on. + +10. Click **Set up source**. You must add the App created in Step 1 to the channels with the data that you want to sync. **For Airbyte Open Source:** -1. Navigate to the Airbyte Open Source dashboard. -2. Set the name for your source. -3. **Required** Enter your `start_date`. -4. **Required** Enter your `lookback_window`, which corresponds to amount of days in the past from which you want to sync data. -5. Toggle `join_channels`, if you want to join all channels or to sync data only from channels the bot is already in. If not set, you'll need to manually add the bot to all the channels from which you'd like to sync messages. -6. Enter your `channel_filter`, this should be list of channel names (without leading '#' char) that limits the channels from which you'd like to sync. If no channels are specified, Airbyte will replicate all data. -7. Toggle `include_private_channels` if you want to sync data from private channels. You will need to manually add the bot to private channels, `join_channel` does not work with private channels. -8. Enter your `api_token`. -9. Click **Set up source**. +1. In the navigation bar, click **Sources**. +2. Click **New source**. +3. Find and click **Slack**. +4. Click **Sign in via Slack (OAuth)**. Enter the Access Token, Client ID, and Client Secret. Alternatively, enter the API Token from Step 1. +5. Toggle `join_channels`, if you want to join all public channels or to sync data only from channels the bot is already in. If not set, you'll need to manually add the bot to all the channels from which you'd like to sync messages. +6. **Start Date**: Any data before this date will not be extracted. +7. **Threads Lookback window (Days)**. This corresponds to the number of days in the past from which you want to sync data. +8. (Optional) **Channel filter** the list of channel names (without leading '#' char) that limits the channels from which you'd like to sync. If no channels are specified, Airbyte will replicate data from all channels. +9. (Optional) **Include_private_channels** Toggle on to sync data from private channels. You will need to manually add the bot to private channels even if `join_channels` is toggled on. +10. Click **Set up source**. You must add the App created in Step 1 to the channels with the data that you want to sync. @@ -132,9 +122,9 @@ For most of the streams, the Slack source connector uses the [Conversations API] ## Performance considerations -The connector is restricted by normal Slack [requests limitation](https://api.slack.com/docs/rate-limits). +The connector is restricted by Slack [rate limits](https://api.slack.com/docs/rate-limits). -It is recommended to sync required channels only, this can be done by specifying config variable `channel_filter` in settings. +We highly recommend only syncing required channels. This can be done by specifying the `channel_filter` in the Slack configuration setings. ## Data type map @@ -164,6 +154,9 @@ Slack has [rate limit restrictions](https://api.slack.com/docs/rate-limits). + + + ## Changelog
@@ -224,5 +217,3 @@ Slack has [rate limit restrictions](https://api.slack.com/docs/rate-limits). | 0.1.7 | 2021-06-25 | [3978](https://github.com/airbytehq/airbyte/pull/3978) | Release Slack CDK Connector |
- - diff --git a/docs/operator-guides/configuring-airbyte.md b/docs/operator-guides/configuring-airbyte.md index a3be7fd702c7..fe330962909f 100644 --- a/docs/operator-guides/configuring-airbyte.md +++ b/docs/operator-guides/configuring-airbyte.md @@ -19,9 +19,9 @@ If you want to manage your own docker files, please refer to Airbyte's docker fi ## Kubernetes Deployments -The recommended way to run an [Airbyte Kubernetes deployment](../deploying-airbyte/on-kubernetes-via-helm.md) is via the `Helm Charts`. +The recommended way to run an [Airbyte Kubernetes deployment](../deploying-airbyte/deploying-airbyte.md) is via the `Helm Charts`. -To configure the Airbyte Kubernetes deployment you need to modify the `values.yaml` file, more [info here](../deploying-airbyte/on-kubernetes-via-helm.md#custom-deployment). +To configure the Airbyte Kubernetes deployment you need to modify the `values.yaml` file, more [info here](../deploying-airbyte/deploying-airbyte.md). Each application will consume the appropriate values from that file. If you want to manage your own Kube manifests, please refer to the `Helm Chart`. diff --git a/docs/operator-guides/using-prefect-task.md b/docs/operator-guides/using-prefect-task.md index 4b65e58972a8..9cedba9e5619 100644 --- a/docs/operator-guides/using-prefect-task.md +++ b/docs/operator-guides/using-prefect-task.md @@ -15,7 +15,7 @@ First, make sure you have Docker installed. We'll be using the `docker-compose` ### **Start Airbyte** -If this is your first time using Airbyte, we suggest going through our [Basic Tutorial](https://github.com/airbytehq/airbyte/tree/e378d40236b6a34e1c1cb481c8952735ec687d88/docs/quickstart/getting-started.md). This tutorial will use the Connection set up in the basic tutorial. +If this is your first time using Airbyte, we suggest going through our [Quickstart](../using-airbyte/getting-started/oss-quickstart). For the purposes of this tutorial, set your Connection's **sync frequency** to **manual**. Prefect will be responsible for manually triggering the Airbyte job. @@ -35,8 +35,6 @@ prefect create project "airbyte" We'll need the Airbyte Connection ID so our Prefect Flow knows which Airbyte Connection to trigger. -![](../.gitbook/assets/airbyte_prefect_connection.png) - This ID can be seen in the URL on the connection page in the Airbyte UI. The Airbyte UI can be accessed at `localhost:8000`. ### Creating a simple Prefect DAG to run an Airbyte Sync Job @@ -70,19 +68,12 @@ The Airbyte Prefect Task accepts the following parameters: After running the file, `python3 airbyte_prefect_flow.py` this will register the Flow in Prefect Server. -![](../.gitbook/assets/airbyte_prefect_register_flow.png) - Access the link from the output from the previous command to see the Flow in Prefect Server, or you can navigate in Prefect UI to find the new Flow -> Access the link from the output from the previous command to see the Flow in the Prefect Server. Alternatively, you can go to the Prefect UI to find the new Flow. -![](../.gitbook/assets/airbyte_prefect_flow.png) - Click on the button `Run` and configure your first run. -![](../.gitbook/assets/airbyte_prefect_flow_configure_run.png) After a few moments you should see the finished run. -![](../.gitbook/assets/airbyte_prefect_flow_run.png) - After that you have the option to configure a more complex Schedule to your Flow. See the [Prefect Schedule docs.](https://docs.prefect.io/core/concepts/schedules.html) ## That's it! diff --git a/docs/reference/README.md b/docs/reference/README.md deleted file mode 100644 index cf5aa0741655..000000000000 --- a/docs/reference/README.md +++ /dev/null @@ -1 +0,0 @@ -# Reference diff --git a/docs/reference/api/README.md b/docs/reference/api/README.md deleted file mode 100644 index 438a512bd9a9..000000000000 --- a/docs/reference/api/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# API Documentation Folder - -- `generated-api-html`: Plain HTML file automatically generated from the Airbyte OAS spec as part of the build. -- `api-documentation.md`: Markdown for API documentation Gitbook [page](https://docs.airbyte.com/api-documentation). -- `rapidoc-api-docs.html`: HTML for actual API Spec Documentation and linked to in the above Gitbook page. This is a S3 static website hosted out of - the [`airbyte-public-api-docs bucket`](https://s3.console.aws.amazon.com/s3/buckets/airbyte-public-api-docs?region=us-east-2&tab=objects) with a [Cloudfront Distribution](https://console.aws.amazon.com/cloudfront/home?#distribution-settings:E35VD0IIC8YUEW) - for SSL. This file points to the Airbyte OAS spec on Master and will automatically mirror spec changes. - This file will need to be uploaded to the `airbyte-public-api-docs` bucket for any file changes to propagate. diff --git a/docs/reference/api/config.yaml b/docs/reference/api/config.yaml deleted file mode 100644 index 8888cf44878c..000000000000 --- a/docs/reference/api/config.yaml +++ /dev/null @@ -1,6143 +0,0 @@ -openapi: 3.0.0 -info: - description: | - Airbyte Configuration API - [https://airbyte.io](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](https://airbyte.com/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}/{METHOD_FAMILY}/{METHOD_NAME} 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=="` - - version: "1.0.0" - title: Airbyte Configuration API - contact: - email: contact@airbyte.io - license: - name: MIT - url: "https://opensource.org/licenses/MIT" -externalDocs: - description: Find out more about Airbyte - url: "https://airbyte.io" -servers: - - url: "http://localhost:8000/api" -tags: - - name: workspace - description: Workspace related resources. - - name: source_definition - description: SourceDefinition related resources. - - name: source_definition_specification - description: SourceDefinition specification related resources. - - name: source - description: Source related resources. - - name: destination_definition - description: DestinationDefinition related resources. - - name: destination_definition_specification - description: DestinationDefinitionSpecification related resources. - - name: destination - description: Destination related resources. - - name: connection - description: Connection between sources and destinations. - - name: destination_oauth - description: Source OAuth related resources to delegate access from user. - - name: source_oauth - description: Source OAuth related resources to delegate access from user. - - name: web_backend - description: | - Endpoints for the Airbyte web application. Those APIs should not be called outside the web application implementation and are not - guaranteeing any backwards compatibility. - - name: health - description: Healthchecks - - name: deployment - description: Export/Import Airbyte Configuration and Database resources. - - name: attempt - description: Interactions with attempt related resources. - - name: state - description: Interactions with state related resources. - -paths: - /v1/workspaces/create: - post: - tags: - - workspace - summary: Creates a workspace - operationId: createWorkspace - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceCreate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceRead" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/workspaces/delete: - post: - tags: - - workspace - summary: Deletes a workspace - operationId: deleteWorkspace - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceIdRequestBody" - required: true - responses: - "204": - description: The resource was deleted successfully. - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/workspaces/list: - post: - tags: - - workspace - summary: List all workspaces registered in the current Airbyte deployment - operationId: listWorkspaces - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceReadList" - /v1/workspaces/get: - post: - tags: - - workspace - summary: Find workspace by ID - operationId: getWorkspace - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/workspaces/get_by_slug: - post: - tags: - - workspace - summary: Find workspace by slug - operationId: getWorkspaceBySlug - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SlugRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/workspaces/get_by_connection_id: - post: - tags: - - workspace - summary: Find workspace by connection id - operationId: getWorkspaceByConnectionId - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/workspaces/update: - post: - tags: - - workspace - summary: Update workspace state - operationId: updateWorkspace - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceUpdate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/workspaces/update_name: - post: - tags: - - workspace - summary: Update workspace name - operationId: updateWorkspaceName - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceUpdateName" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/workspaces/tag_feedback_status_as_done: - post: - tags: - - workspace - summary: Update workspace feedback state - operationId: updateWorkspaceFeedback - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceGiveFeedback" - required: true - responses: - "204": - description: The feedback state has been properly updated - "404": - $ref: "#/components/responses/NotFoundResponse" - /v1/notifications/try: - post: - tags: - - notifications - summary: Try sending a notifications - operationId: tryNotificationConfig - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/Notification" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/NotificationRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - - /v1/source_definitions/update: - post: - tags: - - source_definition - summary: Update a sourceDefinition - operationId: updateSourceDefinition - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDefinitionUpdate" - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDefinitionRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/source_definitions/list: - post: - tags: - - source_definition - summary: List all the sourceDefinitions the current Airbyte deployment is configured to use - operationId: listSourceDefinitions - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDefinitionReadList" - /v1/source_definitions/list_latest: - post: - tags: - - source_definition - summary: List the latest sourceDefinitions Airbyte supports - description: Guaranteed to retrieve the latest information on supported sources. - operationId: listLatestSourceDefinitions - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDefinitionReadList" - /v1/source_definitions/get: - post: - tags: - - source_definition - summary: Get source - operationId: getSourceDefinition - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDefinitionIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDefinitionRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/source_definitions/delete: - post: - tags: - - source_definition - summary: Delete a source definition - operationId: deleteSourceDefinition - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDefinitionIdRequestBody" - required: true - responses: - "204": - description: The resource was deleted successfully. - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/source_definitions/list_private: - post: - tags: - - source_definition - summary: - 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. - operationId: listPrivateSourceDefinitions - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceIdRequestBody" - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/PrivateSourceDefinitionReadList" - /v1/source_definitions/list_for_workspace: - post: - tags: - - source_definition - summary: List all the sourceDefinitions the given workspace is configured to use - operationId: listSourceDefinitionsForWorkspace - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceIdRequestBody" - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDefinitionReadList" - /v1/source_definitions/create_custom: - post: - tags: - - source_definition - summary: Creates a custom sourceDefinition for the given workspace - operationId: createCustomSourceDefinition - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CustomSourceDefinitionCreate" - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDefinitionRead" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/source_definitions/get_for_workspace: - post: - tags: - - source_definition - summary: Get a sourceDefinition that is configured for the given workspace - operationId: getSourceDefinitionForWorkspace - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDefinitionIdWithWorkspaceId" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDefinitionRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/source_definitions/grant_definition: - post: - tags: - - source_definition - summary: grant a private, non-custom sourceDefinition to a given workspace - operationId: grantSourceDefinitionToWorkspace - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDefinitionIdWithWorkspaceId" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/PrivateSourceDefinitionRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/source_definitions/revoke_definition: - post: - tags: - - source_definition - summary: revoke a grant to a private, non-custom sourceDefinition from a given workspace - operationId: revokeSourceDefinitionFromWorkspace - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDefinitionIdWithWorkspaceId" - required: true - responses: - "204": - description: The resource was deleted successfully. - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/source_definition_specifications/get: - post: - tags: - - source_definition_specification - summary: Get specification for a SourceDefinition. - operationId: getSourceDefinitionSpecification - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDefinitionIdWithWorkspaceId" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDefinitionSpecificationRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/source_definition_specifications/get_for_source: - post: - tags: - - source_definition_specification - summary: Get specification for a source. - operationId: getSpecificationForSourceId - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDefinitionSpecificationRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/declarative_source_definitions/create_manifest: - post: - tags: - - declarative_source_definitions - summary: Create a declarative manifest to be used by the specified source definition - operationId: createDeclarativeSourceDefinitionManifest - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DeclarativeSourceDefinitionCreateManifestRequestBody" - required: true - responses: - "201": - description: Successful operation - "400": - description: Definition is not declarative source - "404": - $ref: "#/components/responses/NotFoundResponse" - "409": - description: Version already exists for definition id - /v1/declarative_source_definitions/update_active_manifest: - post: - tags: - - declarative_source_definitions - summary: Update the declarative manifest version for a source - operationId: updateDeclarativeManifestVersion - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateActiveManifestRequestBody" - required: true - responses: - "204": - description: Successful operation - "404": - $ref: "#/components/responses/NotFoundResponse" - /v1/declarative_source_definitions/list_manifests: - post: - tags: - - declarative_source_definitions - summary: List all available declarative manifest versions of a declarative source definition - operationId: listDeclarativeManifests - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ListDeclarativeManifestsRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/DeclarativeManifestsReadList" - "400": - description: Definition is not declarative source - "404": - $ref: "#/components/responses/NotFoundResponse" - /v1/connector_builder_projects/create: - post: - tags: - - connector_builder_project - summary: Create new connector builder project - operationId: createConnectorBuilderProject - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectorBuilderProjectWithWorkspaceId" - required: true - responses: - "201": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectorBuilderProjectIdWithWorkspaceId" - /v1/connector_builder_projects/publish: - post: - tags: - - connector_builder_project - summary: Publish a connector to the workspace - operationId: publishConnectorBuilderProject - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectorBuilderPublishRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDefinitionIdBody" - /v1/connector_builder_projects/update: - post: - tags: - - connector_builder_project - summary: Update connector builder project - operationId: updateConnectorBuilderProject - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ExistingConnectorBuilderProjectWithWorkspaceId" - required: true - responses: - "204": - description: Successful operation - /v1/connector_builder_projects/delete: - post: - tags: - - connector_builder_project - summary: Deletes connector builder project - operationId: deleteConnectorBuilderProject - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectorBuilderProjectIdWithWorkspaceId" - required: true - responses: - "204": - description: Successful operation - /v1/connector_builder_projects/list: - post: - tags: - - connector_builder_project - summary: List connector builder projects for workspace - operationId: listConnectorBuilderProjects - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectorBuilderProjectReadList" - /v1/connector_builder_projects/get_with_manifest: - post: - tags: - - connector_builder_project - summary: Get a connector builder project with draft manifest - operationId: getConnectorBuilderProject - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectorBuilderProjectIdWithWorkspaceId" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectorBuilderProjectRead" - /v1/sources/create: - post: - tags: - - source - summary: Create a source - operationId: createSource - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceCreate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceRead" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/sources/update: - post: - tags: - - source - summary: Update a source - operationId: updateSource - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceUpdate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/sources/partial_update: - post: - tags: - - source - summary: Partially update a source - operationId: partialUpdateSource - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/PartialSourceUpdate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/sources/list: - post: - tags: - - source - summary: List sources for workspace - description: List sources for workspace. Does not return deleted sources. - operationId: listSourcesForWorkspace - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceReadList" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/sources/get: - post: - tags: - - source - summary: Get source - operationId: getSource - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/sources/most_recent_source_actor_catalog: - post: - tags: - - source - summary: Get most recent ActorCatalog for source - operationId: getMostRecentSourceActorCatalog - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/ActorCatalogWithUpdatedAt" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/sources/search: - post: - tags: - - source - summary: Search sources - operationId: searchSources - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceSearch" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceReadList" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/sources/clone: - post: - tags: - - source - summary: Clone source - operationId: cloneSource - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceCloneRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/sources/delete: - post: - tags: - - source - summary: Delete a source - operationId: deleteSource - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceIdRequestBody" - required: true - responses: - "204": - description: The resource was deleted successfully. - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/sources/check_connection: - post: - tags: - - source - summary: Check connection to the source - operationId: checkConnectionToSource - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/CheckConnectionRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/sources/check_connection_for_update: - post: - tags: - - source - summary: Check connection for a proposed update to a source - operationId: checkConnectionToSourceForUpdate - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceUpdate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/CheckConnectionRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/sources/discover_schema: - post: - tags: - - source - summary: Discover the schema catalog of the source - operationId: discoverSchemaForSource - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDiscoverSchemaRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDiscoverSchemaRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/sources/apply_schema_changes: - post: - tags: - - source - summary: - 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. - operationId: applySchemaChangeForSource - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceAutoPropagateChange" - required: true - responses: - "204": - description: The schema was properly auto propagate - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/sources/write_discover_catalog_result: - post: - tags: - - source - - internal - summary: Should only called from worker, to write result from discover activity back to DB. - operationId: writeDiscoverCatalogResult - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDiscoverSchemaWriteRequestBody" - required: true - responses: - "200": - description: Successful Operation - content: - application/json: - schema: - $ref: "#/components/schemas/DiscoverCatalogResult" - /v1/destination_definitions/update: - post: - tags: - - destination_definition - summary: Update destinationDefinition - operationId: updateDestinationDefinition - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationDefinitionUpdate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationDefinitionRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destination_definitions/list: - post: - tags: - - destination_definition - summary: List all the destinationDefinitions the current Airbyte deployment is configured to use - operationId: listDestinationDefinitions - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationDefinitionReadList" - /v1/destination_definitions/list_latest: - post: - tags: - - destination_definition - summary: List the latest destinationDefinitions Airbyte supports - description: Guaranteed to retrieve the latest information on supported destinations. - operationId: listLatestDestinationDefinitions - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationDefinitionReadList" - /v1/destination_definitions/get: - post: - tags: - - destination_definition - summary: Get destinationDefinition - operationId: getDestinationDefinition - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationDefinitionIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationDefinitionRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destination_definitions/delete: - post: - tags: - - destination_definition - summary: Delete a destination definition - operationId: deleteDestinationDefinition - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationDefinitionIdRequestBody" - required: true - responses: - "204": - description: The resource was deleted successfully. - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destination_definitions/list_private: - post: - tags: - - destination_definition - summary: - 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. - operationId: listPrivateDestinationDefinitions - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceIdRequestBody" - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/PrivateDestinationDefinitionReadList" - /v1/destination_definitions/list_for_workspace: - post: - tags: - - destination_definition - summary: List all the destinationDefinitions the given workspace is configured to use - operationId: listDestinationDefinitionsForWorkspace - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceIdRequestBody" - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationDefinitionReadList" - /v1/destination_definitions/create_custom: - post: - tags: - - destination_definition - summary: Creates a custom destinationDefinition for the given workspace - operationId: createCustomDestinationDefinition - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CustomDestinationDefinitionCreate" - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationDefinitionRead" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destination_definitions/get_for_workspace: - post: - tags: - - destination_definition - summary: Get a destinationDefinition that is configured for the given workspace - operationId: getDestinationDefinitionForWorkspace - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationDefinitionIdWithWorkspaceId" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationDefinitionRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destination_definitions/grant_definition: - post: - tags: - - destination_definition - summary: grant a private, non-custom destinationDefinition to a given workspace - operationId: grantDestinationDefinitionToWorkspace - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationDefinitionIdWithWorkspaceId" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/PrivateDestinationDefinitionRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destination_definitions/revoke_definition: - post: - tags: - - destination_definition - summary: revoke a grant to a private, non-custom destinationDefinition from a given workspace - operationId: revokeDestinationDefinitionFromWorkspace - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationDefinitionIdWithWorkspaceId" - required: true - responses: - "204": - description: The resource was deleted successfully. - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destination_definition_specifications/get: - post: - tags: - - destination_definition_specification - summary: Get specification for a destinationDefinition - operationId: getDestinationDefinitionSpecification - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationDefinitionIdWithWorkspaceId" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationDefinitionSpecificationRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destination_definition_specifications/get_for_destination: - post: - tags: - - destination_definition_specification - summary: Get specification for a destination - operationId: getSpecificationForDestinationId - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationDefinitionSpecificationRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - # DESTINATIONS - /v1/destinations/create: - post: - tags: - - destination - summary: Create a destination - operationId: createDestination - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationCreate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationRead" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destinations/update: - post: - tags: - - destination - summary: Update a destination - operationId: updateDestination - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationUpdate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationRead" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destinations/partial_update: - post: - tags: - - destination - summary: Update a destination partially - operationId: partialUpdateDestination - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/PartialDestinationUpdate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationRead" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destinations/list: - post: - tags: - - destination - summary: List configured destinations for a workspace - operationId: listDestinationsForWorkspace - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationReadList" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destinations/get: - post: - tags: - - destination - summary: Get configured destination - operationId: getDestination - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destinations/search: - post: - tags: - - destination - summary: Search destinations - operationId: searchDestinations - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationSearch" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationReadList" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destinations/check_connection: - post: - tags: - - destination - summary: Check connection to the destination - operationId: checkConnectionToDestination - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/CheckConnectionRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destinations/check_connection_for_update: - post: - tags: - - destination - summary: Check connection for a proposed update to a destination - operationId: checkConnectionToDestinationForUpdate - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationUpdate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/CheckConnectionRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destinations/delete: - post: - tags: - - destination - summary: Delete the destination - operationId: deleteDestination - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationIdRequestBody" - required: true - responses: - "204": - description: The resource was deleted successfully. - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destinations/clone: - post: - tags: - - destination - summary: Clone destination - operationId: cloneDestination - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationCloneRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/connections/create: - post: - tags: - - connection - summary: Create a connection between a source and a destination - operationId: createConnection - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionCreate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionRead" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/connections/update: - post: - tags: - - connection - summary: Update a connection - description: | - Apply a patch-style update to a connection. Only fields present on the update request body will be updated. - Note that if a catalog is present in the request body, the connection's entire catalog will be replaced - with the catalog from the request. This means that to modify a single stream, the entire new catalog - containing the updated stream needs to be sent. - operationId: updateConnection - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionUpdate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionRead" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/connections/list: - post: - tags: - - connection - summary: Returns all connections for a workspace. - description: List connections for workspace. Does not return deleted connections. - operationId: listConnectionsForWorkspace - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionReadList" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/connections/list_all: - post: - tags: - - connection - summary: Returns all connections for a workspace, including deleted connections. - description: List connections for workspace, including deleted connections. - operationId: listAllConnectionsForWorkspace - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WorkspaceIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionReadList" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/connections/get: - post: - tags: - - connection - summary: Get a connection - operationId: getConnection - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/connections/list_by_actor_definition: - post: - tags: - - connection - summary: List all connections that use the provided actor definition - operationId: listConnectionsByActorDefinition - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ActorDefinitionRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionReadList" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/state/get: - post: - tags: - - state - summary: Fetch the current state for a connection. - operationId: getState - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionState" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/state/create_or_update: - post: - tags: - - state - - internal - summary: Create or update the state for a connection. - operationId: createOrUpdateState - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionStateCreateOrUpdate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionState" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/connections/search: - post: - tags: - - connection - summary: Search connections - operationId: searchConnections - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionSearch" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionReadList" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/connections/delete: - post: - tags: - - connection - summary: Delete a connection - operationId: deleteConnection - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionIdRequestBody" - required: true - responses: - "204": - description: The resource was deleted successfully. - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/connections/sync: - post: - tags: - - connection - summary: Trigger a manual sync of the connection - operationId: syncConnection - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/JobInfoRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/connections/reset: - post: - tags: - - connection - summary: Reset the data for the connection. Deletes data generated by the connection in the destination. Resets any cursors back to initial state. - operationId: resetConnection - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/JobInfoRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/connections/reset/stream: - post: - tags: - - connection - summary: 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. - operationId: resetConnectionStream - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionStreamRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/JobInfoRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/operations/check: - post: - tags: - - operation - summary: Check if an operation to be created is valid - operationId: checkOperation - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/OperatorConfiguration" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/CheckOperationRead" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/operations/create: - post: - tags: - - operation - summary: Create an operation to be applied as part of a connection pipeline - operationId: createOperation - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/OperationCreate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/OperationRead" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/operations/update: - post: - tags: - - operation - summary: Update an operation - operationId: updateOperation - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/OperationUpdate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/OperationRead" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/operations/list: - post: - tags: - - operation - summary: Returns all operations for a connection. - description: List operations for connection. - operationId: listOperationsForConnection - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/OperationReadList" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/operations/get: - post: - tags: - - operation - summary: Returns an operation - operationId: getOperation - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/OperationIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/OperationRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/operations/delete: - post: - tags: - - operation - summary: Delete an operation - operationId: deleteOperation - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/OperationIdRequestBody" - required: true - responses: - "204": - description: The resource was deleted successfully. - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/scheduler/sources/check_connection: - post: - tags: - - scheduler - summary: Run check connection for a given source configuration - operationId: executeSourceCheckConnection - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceCoreConfig" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/CheckConnectionRead" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/scheduler/sources/discover_schema: - post: - tags: - - scheduler - summary: Run discover schema for a given source a source configuration - operationId: executeSourceDiscoverSchema - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceCoreConfig" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/SourceDiscoverSchemaRead" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/scheduler/destinations/check_connection: - post: - tags: - - scheduler - summary: Run check connection for a given destination configuration - operationId: executeDestinationCheckConnection - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationCoreConfig" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/CheckConnectionRead" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/source_oauths/oauth_params/create: - post: - tags: - - source_oauth - summary: > - 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 developer_token, client_id, and client_secret without the user having to know - about these variables. - operationId: setInstancewideSourceOauthParams - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SetInstancewideSourceOauthParamsRequestBody" - required: true - responses: - "200": - description: Successful - "400": - $ref: "#/components/responses/ExceptionResponse" - "404": - $ref: "#/components/responses/NotFoundResponse" - /v1/source_oauths/get_consent_url: - post: - tags: - - source_oauth - summary: Given a source connector definition ID, return the URL to the consent screen where to redirect the user to. - operationId: getSourceOAuthConsent - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SourceOauthConsentRequest" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/OAuthConsentRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/source_oauths/complete_oauth: - post: - tags: - - source_oauth - summary: Given a source def ID generate an access/refresh token etc. - operationId: completeSourceOAuth - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CompleteSourceOauthRequest" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/CompleteOAuthResponse" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/source_oauths/revoke: - post: - tags: - - source_oauth - summary: Given a source definition ID and workspace ID revoke access/refresh token etc. - operationId: revokeSourceOAuthTokens - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/RevokeSourceOauthTokensRequest" - required: true - responses: - "200": - description: Successful operation - "400": - $ref: "#/components/responses/ExceptionResponse" - "404": - $ref: "#/components/responses/NotFoundResponse" - /v1/destination_oauths/get_consent_url: - post: - tags: - - destination_oauth - summary: Given a destination connector definition ID, return the URL to the consent screen where to redirect the user to. - operationId: getDestinationOAuthConsent - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DestinationOauthConsentRequest" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/OAuthConsentRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destination_oauths/complete_oauth: - post: - tags: - - destination_oauth - summary: Given a destination def ID generate an access/refresh token etc. - operationId: completeDestinationOAuth - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CompleteDestinationOAuthRequest" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/CompleteOAuthResponse" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/destination_oauths/oauth_params/create: - post: - tags: - - destination_oauth - summary: > - 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 developer_token, client_id, and client_secret without the user having to know - about these variables. - operationId: setInstancewideDestinationOauthParams - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SetInstancewideDestinationOauthParamsRequestBody" - required: true - responses: - "200": - description: Successful - "400": - $ref: "#/components/responses/ExceptionResponse" - "404": - $ref: "#/components/responses/NotFoundResponse" - /v1/web_backend/check_updates: - post: - tags: - - web_backend - summary: Returns a summary of source and destination definitions that could be updated. - operationId: webBackendCheckUpdates - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/WebBackendCheckUpdatesRead" - /v1/web_backend/connections/list: - post: - tags: - - web_backend - summary: Returns all non-deleted connections for a workspace. - operationId: webBackendListConnectionsForWorkspace - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WebBackendConnectionListRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/WebBackendConnectionReadList" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/web_backend/connections/get: - post: - tags: - - web_backend - summary: Get a connection - operationId: webBackendGetConnection - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WebBackendConnectionRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/WebBackendConnectionRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/web_backend/connections/create: - post: - tags: - - web_backend - summary: Create a connection - operationId: webBackendCreateConnection - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WebBackendConnectionCreate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/WebBackendConnectionRead" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/web_backend/connections/update: - post: - tags: - - web_backend - summary: Update a connection - description: | - Apply a patch-style update to a connection. Only fields present on the update request body will be updated. - Any operations that lack an ID will be created. Then, the newly created operationId will be applied to the - connection along with the rest of the operationIds in the request body. - Apply a patch-style update to a connection. Only fields present on the update request body will be updated. - Note that if a catalog is present in the request body, the connection's entire catalog will be replaced - with the catalog from the request. This means that to modify a single stream, the entire new catalog - containing the updated stream needs to be sent. - operationId: webBackendUpdateConnection - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WebBackendConnectionUpdate" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/WebBackendConnectionRead" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/web_backend/state/get_type: - post: - tags: - - web_backend - summary: Fetch the current state type for a connection. - operationId: getStateType - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionStateType" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/web_backend/workspace/state: - post: - tags: - - web_backend - summary: Returns the current state of a workspace - operationId: webBackendGetWorkspaceState - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/WebBackendWorkspaceState" - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/WebBackendWorkspaceStateResult" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/web_backend/geographies/list: - post: - tags: - - web_backend - description: Returns all available geographies in which a data sync can run. - summary: | - 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. - operationId: webBackendListGeographies - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/WebBackendGeographiesListResult" - /v1/jobs/list: - post: - tags: - - jobs - summary: Returns recent jobs for a connection. Jobs are returned in descending order by createdAt. - operationId: listJobsFor - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/JobListRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/JobReadList" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/jobs/get: - post: - tags: - - jobs - summary: Get information about a job - operationId: getJobInfo - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/JobIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/JobInfoRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/jobs/get_last_replication_job: - post: - tags: - - jobs - operationId: getLastReplicationJob - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ConnectionIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/JobOptionalRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/jobs/get_without_logs: - post: - tags: - - jobs - summary: Get information about a job excluding logs - operationId: getJobInfoWithoutLogs - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/JobIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/JobInfoRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/jobs/get_light: - post: - tags: - - jobs - summary: Get information about a job excluding attempt info and logs - operationId: getJobInfoLight - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/JobIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/JobInfoLightRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/jobs/cancel: - post: - tags: - - jobs - summary: Cancels a job - operationId: cancelJob - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/JobIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/JobInfoRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/jobs/get_debug_info: - post: - tags: - - jobs - summary: Gets all information needed to debug this job - operationId: getJobDebugInfo - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/JobIdRequestBody" - required: true - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/JobDebugInfoRead" - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/jobs/get_normalization_status: - post: - tags: - - jobs - - internal - summary: Get normalization status to determine if we can bypass normalization phase - operationId: getAttemptNormalizationStatusesForJob - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/JobIdRequestBody" - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/AttemptNormalizationStatusReadList" - - /v1/health: - get: - tags: - - health - summary: Health Check - operationId: getHealthCheck - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/HealthCheckRead" - # This route is unsecured for external monitoring. - security: [] - /v1/logs/get: - post: - tags: - - logs - summary: Get logs - operationId: getLogs - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/LogsRequestBody" - required: true - responses: - "200": - description: Returns the log file - content: - text/plain: - schema: - type: string - format: binary - "404": - $ref: "#/components/responses/NotFoundResponse" - "422": - $ref: "#/components/responses/InvalidInputResponse" - /v1/openapi: - get: - tags: - - openapi - summary: Returns the openapi specification - operationId: getOpenApiSpec - responses: - "200": - description: Returns the openapi specification file - content: - text/plain: - schema: - type: string - format: binary - /v1/attempt/set_workflow_in_attempt: - post: - tags: - - attempt - - internal - summary: For worker to register the workflow id in attempt. - operationId: setWorkflowInAttempt - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SetWorkflowInAttemptRequestBody" - required: true - responses: - "200": - description: Successful Operation - content: - application/json: - schema: - $ref: "#/components/schemas/InternalOperationResult" - /v1/attempt/save_stats: - post: - tags: - - attempt - - internal - summary: For worker to set sync stats of a running attempt. - operationId: saveStats - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SaveStatsRequestBody" - required: true - responses: - "200": - description: Successful Operation - content: - application/json: - schema: - $ref: "#/components/schemas/InternalOperationResult" - /v1/attempt/save_sync_config: - post: - tags: - - attempt - - internal - summary: For worker to save the AttemptSyncConfig for an attempt. - operationId: saveSyncConfig - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SaveAttemptSyncConfigRequestBody" - required: true - responses: - "200": - description: Successful Operation - content: - application/json: - schema: - $ref: "#/components/schemas/InternalOperationResult" - /v1/stream_statuses/list: - post: - summary: Gets a list of stream statuses filtered by parameters (with AND semantics). - tags: - - stream_statuses - - streams - operationId: getStreamStatuses - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/StreamStatusListRequestBody" - responses: - "200": - description: Successfully queried stream statuses. - content: - application/json: - schema: - $ref: "#/components/schemas/StreamStatusReadList" - /v1/stream_statuses/create: - post: - summary: Creates a stream status. - tags: - - stream_statuses - - streams - operationId: createStreamStatus - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/StreamStatusCreateRequestBody" - responses: - "201": - description: Successfully created stream status. - content: - application/json: - schema: - $ref: "#/components/schemas/StreamStatusRead" - /v1/stream_statuses/update: - post: - summary: Updates a stream status. - tags: - - stream_statuses - - streams - operationId: updateStreamStatus - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/StreamStatusUpdateRequestBody" - responses: - "201": - description: Successfully created stream status. - content: - application/json: - schema: - $ref: "#/components/schemas/StreamStatusRead" - "200": - description: Successfully updated stream status. - content: - application/json: - schema: - $ref: "#/components/schemas/StreamStatusRead" -components: - securitySchemes: - bearerAuth: - type: http - scheme: bearer - bearerFormat: JWT - schemas: - # WORKSPACE - WorkspaceId: - type: string - format: uuid - CustomerId: - type: string - format: uuid - WorkspaceCreate: - type: object - required: - - name - properties: - email: - type: string - format: email - anonymousDataCollection: - type: boolean - name: - type: string - news: - type: boolean - securityUpdates: - type: boolean - notifications: - type: array - items: - $ref: "#/components/schemas/Notification" - notificationSettings: - $ref: "#/components/schemas/NotificationSettings" - displaySetupWizard: - type: boolean - defaultGeography: - $ref: "#/components/schemas/Geography" - webhookConfigs: - type: array - items: - $ref: "#/components/schemas/WebhookConfigWrite" - WebhookConfigWrite: - type: object - properties: - name: - type: string - description: human readable name for this webhook e.g. for UI display. - authToken: - type: string - description: an auth token, to be passed as the value for an HTTP Authorization header. - validationUrl: - type: string - description: if supplied, the webhook config will be validated by checking that this URL returns a 2xx response. - NotificationItem: - type: object - properties: - notificationType: - type: array - items: - $ref: "#/components/schemas/NotificationType" - slackConfiguration: - $ref: "#/components/schemas/SlackNotificationConfiguration" - customerioConfiguration: - $ref: "#/components/schemas/CustomerioNotificationConfiguration" - - NotificationSettings: - type: object - properties: - sendOnSuccess: - $ref: "#/components/schemas/NotificationItem" - sendOnFailure: - $ref: "#/components/schemas/NotificationItem" - sendOnSyncDisabled: - $ref: "#/components/schemas/NotificationItem" - sendOnSyncDisabledWarning: - $ref: "#/components/schemas/NotificationItem" - sendOnConnectionUpdate: - $ref: "#/components/schemas/NotificationItem" - sendOnConnectionUpdateActionRequired: - $ref: "#/components/schemas/NotificationItem" - - Notification: - type: object - required: - - notificationType - - sendOnSuccess - - sendOnFailure - properties: - # Instead of this type field, we would prefer a json schema "oneOf" but unfortunately, - # the jsonschema2pojo does not seem to support it yet: https://github.com/joelittlejohn/jsonschema2pojo/issues/392 - notificationType: - $ref: "#/components/schemas/NotificationType" - sendOnSuccess: - type: boolean - default: false - sendOnFailure: - type: boolean - default: true - slackConfiguration: - $ref: "#/components/schemas/SlackNotificationConfiguration" - customerioConfiguration: - $ref: "#/components/schemas/CustomerioNotificationConfiguration" - SlackNotificationConfiguration: - type: object - required: - - webhook - properties: - webhook: - type: string - CustomerioNotificationConfiguration: - type: object - NotificationType: - type: string - enum: - - slack - - customerio - # - webhook - NotificationRead: - type: object - required: - - status - properties: - status: - type: string - enum: - - succeeded - - failed - message: - type: string - WorkspaceIdRequestBody: - type: object - required: - - workspaceId - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - ListConnectionsForWorkspacesRequestBody: - type: object - required: - - workspaceIds - - userId - properties: - workspaceIds: - type: array - items: - $ref: "#/components/schemas/WorkspaceId" - userId: - type: string - format: uuid - pagination: - $ref: "#/components/schemas/Pagination" - includeDeleted: - type: boolean - default: false - ListResourcesForWorkspacesRequestBody: - type: object - required: - - workspaceIds - properties: - workspaceIds: - type: array - items: - $ref: "#/components/schemas/WorkspaceId" - includeDeleted: - type: boolean - default: false - pagination: - $ref: "#/components/schemas/Pagination" - WorkspaceReadList: - type: object - required: - - workspaces - properties: - workspaces: - type: array - items: - $ref: "#/components/schemas/WorkspaceRead" - WorkspaceRead: - type: object - required: - - workspaceId - - customerId - - name - - slug - - initialSetupComplete - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - customerId: - $ref: "#/components/schemas/CustomerId" - email: - type: string - format: email - name: - type: string - slug: - type: string - initialSetupComplete: - type: boolean - displaySetupWizard: - type: boolean - anonymousDataCollection: - type: boolean - news: - type: boolean - securityUpdates: - type: boolean - notifications: - type: array - items: - $ref: "#/components/schemas/Notification" - notificationSettings: - $ref: "#/components/schemas/NotificationSettings" - firstCompletedSync: - type: boolean - feedbackDone: - type: boolean - defaultGeography: - $ref: "#/components/schemas/Geography" - webhookConfigs: - type: array - items: - # Note: this omits any sensitive info e.g. auth token - $ref: "#/components/schemas/WebhookConfigRead" - WebhookConfigRead: - type: object - description: the readable info for a webhook config; omits sensitive info e.g. auth token - required: - - id - properties: - id: - type: string - format: uuid - name: - type: string - description: human-readable name e.g. for display in UI - WorkspaceUpdateName: - type: object - required: - - workspaceId - - name - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - name: - type: string - WorkspaceUpdate: - type: object - description: Used to apply a patch-style update to a workspace, which means that null properties remain unchanged - required: - - workspaceId - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - email: - type: string - format: email - initialSetupComplete: - type: boolean - displaySetupWizard: - type: boolean - anonymousDataCollection: - type: boolean - news: - type: boolean - securityUpdates: - type: boolean - notifications: - type: array - items: - $ref: "#/components/schemas/Notification" - notificationSettings: - $ref: "#/components/schemas/NotificationSettings" - defaultGeography: - $ref: "#/components/schemas/Geography" - webhookConfigs: - type: array - items: - $ref: "#/components/schemas/WebhookConfigWrite" - WorkspaceGiveFeedback: - type: object - required: - - workspaceId - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - WebBackendWorkspaceState: - type: object - required: - - workspaceId - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - WebBackendWorkspaceStateResult: - type: object - required: - - hasConnections - - hasSources - - hasDestinations - properties: - hasConnections: - type: boolean - hasSources: - type: boolean - hasDestinations: - type: boolean - WebBackendGeographiesListResult: - type: object - required: - - geographies - properties: - geographies: - type: array - items: - $ref: "#/components/schemas/Geography" - # SLUG - SlugRequestBody: - type: object - required: - - slug - properties: - slug: - type: string - # Geography - Geography: - type: string - enum: - - auto - - us - - eu - # BuilderProject - ConnectorBuilderProjectId: - type: string - format: uuid - DeclarativeManifest: - description: Low code CDK manifest JSON object - type: object - DeclarativeManifestRead: - type: object - properties: - manifest: - $ref: "#/components/schemas/DeclarativeManifest" - isDraft: - type: boolean - version: - $ref: "#/components/schemas/ManifestVersion" - description: - type: string - ConnectorBuilderProjectDetails: - type: object - required: - - name - properties: - name: - type: string - draftManifest: - $ref: "#/components/schemas/DeclarativeManifest" - ConnectorBuilderProjectDetailsRead: - type: object - required: - - name - - builderProjectId - - hasDraft - properties: - name: - type: string - builderProjectId: - $ref: "#/components/schemas/ConnectorBuilderProjectId" - sourceDefinitionId: - $ref: "#/components/schemas/SourceDefinitionId" - activeDeclarativeManifestVersion: - $ref: "#/components/schemas/ManifestVersion" - hasDraft: - type: boolean - ConnectorBuilderProjectIdWithWorkspaceId: - type: object - required: - - workspaceId - - builderProjectId - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - builderProjectId: - $ref: "#/components/schemas/ConnectorBuilderProjectId" - version: - $ref: "#/components/schemas/ManifestVersion" - ExistingConnectorBuilderProjectWithWorkspaceId: - type: object - required: - - workspaceId - - builderProjectId - - builderProject - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - builderProjectId: - $ref: "#/components/schemas/ConnectorBuilderProjectId" - builderProject: - $ref: "#/components/schemas/ConnectorBuilderProjectDetails" - ConnectorBuilderProjectWithWorkspaceId: - type: object - required: - - workspaceId - - builderProject - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - builderProject: - $ref: "#/components/schemas/ConnectorBuilderProjectDetails" - ConnectorBuilderProjectRead: - type: object - required: - - builderProject - properties: - builderProject: - $ref: "#/components/schemas/ConnectorBuilderProjectDetailsRead" - declarativeManifest: - $ref: "#/components/schemas/DeclarativeManifestRead" - ConnectorBuilderProjectReadList: - type: object - required: - - projects - properties: - projects: - type: array - items: - $ref: "#/components/schemas/ConnectorBuilderProjectDetailsRead" - ConnectorBuilderPublishRequestBody: - type: object - required: - - workspaceId - - builderProjectId - - name - - initialDeclarativeManifest - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - builderProjectId: - $ref: "#/components/schemas/ConnectorBuilderProjectId" - name: - type: string - initialDeclarativeManifest: - $ref: "#/components/schemas/DeclarativeSourceManifest" - ManifestVersion: - type: integer - format: int64 - DeclarativeSourceManifest: - type: object - required: - - description - - manifest - - spec - - version - properties: - description: - type: string - manifest: - $ref: "#/components/schemas/DeclarativeManifest" - spec: - $ref: "#/components/schemas/SourceDefinitionSpecification" - version: - $ref: "#/components/schemas/ManifestVersion" - SourceDefinitionIdBody: - type: object - required: - - sourceDefinitionId - properties: - sourceDefinitionId: - $ref: "#/components/schemas/SourceDefinitionId" - # SourceDefinition - SourceDefinitionId: - type: string - format: uuid - SourceDefinitionIdRequestBody: - type: object - required: - - sourceDefinitionId - properties: - sourceDefinitionId: - $ref: "#/components/schemas/SourceDefinitionId" - SourceDefinitionCreate: - type: object - required: - - name - - dockerRepository - - dockerImageTag - - documentationUrl - properties: - name: - type: string - dockerRepository: - type: string - dockerImageTag: - type: string - documentationUrl: - type: string - format: uri - icon: - type: string - resourceRequirements: - $ref: "#/components/schemas/ActorDefinitionResourceRequirements" - SourceDefinitionUpdate: - type: object - description: Update the SourceDefinition. Currently, the only allowed attribute to update is the default docker image version. - required: - - sourceDefinitionId - - dockerImageTag - properties: - sourceDefinitionId: - $ref: "#/components/schemas/SourceDefinitionId" - dockerImageTag: - type: string - resourceRequirements: - $ref: "#/components/schemas/ActorDefinitionResourceRequirements" - SourceDefinitionRead: - type: object - required: - - sourceDefinitionId - - name - - dockerRepository - - dockerImageTag - properties: - sourceDefinitionId: - $ref: "#/components/schemas/SourceDefinitionId" - name: - type: string - dockerRepository: - type: string - dockerImageTag: - type: string - documentationUrl: - type: string - format: uri - icon: - type: string - protocolVersion: - description: The Airbyte Protocol version supported by the connector - type: string - releaseStage: - $ref: "#/components/schemas/ReleaseStage" - releaseDate: - description: The date when this connector was first released, in yyyy-mm-dd format. - type: string - format: date - sourceType: - type: string - enum: - - api - - file - - database - - custom - resourceRequirements: - $ref: "#/components/schemas/ActorDefinitionResourceRequirements" - maxSecondsBetweenMessages: - description: Number of seconds allowed between 2 airbyte protocol messages. The source will timeout if this delay is reach - type: integer - format: int64 - SourceDefinitionReadList: - type: object - required: - - sourceDefinitions - properties: - sourceDefinitions: - type: array - items: - $ref: "#/components/schemas/SourceDefinitionRead" - CustomSourceDefinitionCreate: - type: object - required: - - workspaceId - - sourceDefinition - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - sourceDefinition: - $ref: "#/components/schemas/SourceDefinitionCreate" - SourceDefinitionIdWithWorkspaceId: - type: object - required: - - sourceDefinitionId - - workspaceId - properties: - sourceDefinitionId: - $ref: "#/components/schemas/SourceDefinitionId" - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - ListDeclarativeManifestsRequestBody: - type: object - required: - - workspaceId - - sourceDefinitionId - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - sourceDefinitionId: - $ref: "#/components/schemas/SourceDefinitionId" - DeclarativeManifestsReadList: - type: object - required: - - manifestVersions - properties: - manifestVersions: - type: array - items: - $ref: "#/components/schemas/DeclarativeManifestVersionRead" - DeclarativeManifestVersionRead: - type: object - required: - - version - - isActive - - description - properties: - version: - type: integer - format: int64 - isActive: - type: boolean - description: - type: string - DeclarativeSourceDefinitionCreateManifestRequestBody: - type: object - required: - - workspaceId - - sourceDefinitionId - - setAsActiveManifest - - declarativeManifest - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - sourceDefinitionId: - $ref: "#/components/schemas/ConnectorBuilderProjectId" - setAsActiveManifest: - type: boolean - declarativeManifest: - $ref: "#/components/schemas/DeclarativeSourceManifest" - UpdateActiveManifestRequestBody: - type: object - required: - - workspaceId - - sourceDefinitionId - - version - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - sourceDefinitionId: - $ref: "#/components/schemas/ConnectorBuilderProjectId" - version: - $ref: "#/components/schemas/ManifestVersion" - PrivateSourceDefinitionRead: - type: object - required: - - sourceDefinition - - granted - properties: - sourceDefinition: - $ref: "#/components/schemas/SourceDefinitionRead" - granted: - type: boolean - PrivateSourceDefinitionReadList: - type: object - required: - - sourceDefinitions - properties: - sourceDefinitions: - type: array - items: - $ref: "#/components/schemas/PrivateSourceDefinitionRead" - # SOURCE SPECIFICATION - SourceDefinitionSpecification: - description: The specification for what values are required to configure the sourceDefinition. - type: object - example: { user: { type: string } } - SourceDefinitionSpecificationRead: - type: object - required: - - sourceDefinitionId - - jobInfo - properties: - sourceDefinitionId: - $ref: "#/components/schemas/SourceDefinitionId" - documentationUrl: - type: string - connectionSpecification: - $ref: "#/components/schemas/SourceDefinitionSpecification" - advancedAuth: - $ref: "#/components/schemas/AdvancedAuth" - jobInfo: - $ref: "#/components/schemas/SynchronousJobRead" - # SOURCE - SourceId: - type: string - format: uuid - SourceIdRequestBody: - type: object - required: - - sourceId - properties: - sourceId: - $ref: "#/components/schemas/SourceId" - SourceCloneRequestBody: - description: The values required to configure the source. The schema for this should have an id of the existing source along with the configuration you want to change in case. - type: object - required: - - sourceCloneId - properties: - sourceCloneId: - $ref: "#/components/schemas/SourceId" - sourceConfiguration: - $ref: "#/components/schemas/SourceCloneConfiguration" - SourceCloneConfiguration: - type: object - properties: - connectionConfiguration: - $ref: "#/components/schemas/SourceConfiguration" - name: - type: string - SourceConfiguration: - description: The values required to configure the source. The schema for this must match the schema return by source_definition_specifications/get for the source. - example: { user: "charles" } - SourceCoreConfig: - type: object - required: - - sourceDefinitionId - - connectionConfiguration - - workspaceId - properties: - sourceId: - $ref: "#/components/schemas/SourceId" - sourceDefinitionId: - $ref: "#/components/schemas/SourceDefinitionId" - connectionConfiguration: - $ref: "#/components/schemas/SourceConfiguration" - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - SourceCreate: - type: object - required: - - workspaceId - - name - - sourceDefinitionId - - connectionConfiguration - properties: - sourceDefinitionId: - $ref: "#/components/schemas/SourceDefinitionId" - connectionConfiguration: - $ref: "#/components/schemas/SourceConfiguration" - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - name: - type: string - secretId: - example: "airbyte_oauth_workspace_0509f049-d671-48cb-8105-0a23d47e6db6_secret_e0d38206-034e-4d75-9d21-da5a99b02826_v1" - type: string - SourceDiscoverSchemaRequestBody: - type: object - required: - - sourceId - properties: - sourceId: - $ref: "#/components/schemas/SourceId" - connectionId: - type: string - format: uuid - disable_cache: - type: boolean - notifySchemaChange: - type: boolean - PartialSourceUpdate: - type: object - required: - - sourceId - properties: - sourceId: - $ref: "#/components/schemas/SourceId" - connectionConfiguration: - $ref: "#/components/schemas/SourceConfiguration" - name: - type: string - secretId: - example: "airbyte_oauth_workspace_0509f049-d671-48cb-8105-0a23d47e6db6_secret_e0d38206-034e-4d75-9d21-da5a99b02826_v1" - type: string - SourceUpdate: - type: object - required: - - sourceId - - connectionConfiguration - - name - properties: - sourceId: - $ref: "#/components/schemas/SourceId" - connectionConfiguration: - $ref: "#/components/schemas/SourceConfiguration" - name: - type: string - secretId: - example: "airbyte_oauth_workspace_0509f049-d671-48cb-8105-0a23d47e6db6_secret_e0d38206-034e-4d75-9d21-da5a99b02826_v1" - type: string - SourceRead: - type: object - required: - - sourceDefinitionId - - sourceId - - workspaceId - - connectionConfiguration - - name - - sourceName - properties: - sourceDefinitionId: - $ref: "#/components/schemas/SourceDefinitionId" - sourceId: - $ref: "#/components/schemas/SourceId" - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - connectionConfiguration: - $ref: "#/components/schemas/SourceConfiguration" - name: - type: string - sourceName: - type: string - icon: - type: string - SourceSnippetRead: - type: object - required: - - sourceId - - name - - sourceDefinitionId - - sourceName - properties: - sourceId: - $ref: "#/components/schemas/SourceId" - name: - type: string - sourceDefinitionId: - $ref: "#/components/schemas/SourceDefinitionId" - sourceName: - type: string - icon: - type: string - SourceReadList: - type: object - required: - - sources - properties: - sources: - type: array - items: - $ref: "#/components/schemas/SourceRead" - SourceDiscoverSchemaWriteRequestBody: - description: to write this requested object to database. - type: object - required: - - catalog - properties: - catalog: - $ref: "#/components/schemas/AirbyteCatalog" - sourceId: - $ref: "#/components/schemas/SourceId" - connectorVersion: - type: string - configurationHash: - type: string - - SourceDiscoverSchemaRead: - description: Returns the results of a discover catalog job. If the job was not successful, the catalog field will not be present. jobInfo will aways be present and its status be used to determine if the job was successful or not. - type: object - required: - - jobInfo - properties: - catalog: - $ref: "#/components/schemas/AirbyteCatalog" - jobInfo: - $ref: "#/components/schemas/SynchronousJobRead" - catalogId: - type: string - format: uuid - catalogDiff: - $ref: "#/components/schemas/CatalogDiff" - breakingChange: - type: boolean - connectionStatus: - $ref: "#/components/schemas/ConnectionStatus" - SourceAutoPropagateChange: - description: - Input of the source propagation, it contains the discovered catalog and a list of diff that need to be applied - to the existing catalog. - type: object - required: - - catalog - - catalogId - - sourceId - - workspaceId - properties: - catalog: - $ref: "#/components/schemas/AirbyteCatalog" - catalogId: - type: string - format: uuid - sourceId: - type: string - format: uuid - workspaceId: - type: string - format: uuid - SourceSearch: - type: object - properties: - sourceDefinitionId: - $ref: "#/components/schemas/SourceDefinitionId" - sourceId: - $ref: "#/components/schemas/SourceId" - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - connectionConfiguration: - $ref: "#/components/schemas/SourceConfiguration" - name: - type: string - sourceName: - type: string - # DESTINATION DEFINITION - DestinationDefinitionId: - type: string - format: uuid - DestinationDefinitionIdRequestBody: - type: object - required: - - destinationDefinitionId - properties: - destinationDefinitionId: - $ref: "#/components/schemas/DestinationDefinitionId" - DestinationDefinitionCreate: - type: object - required: - - name - - dockerRepository - - dockerImageTag - - documentationUrl - properties: - name: - type: string - dockerRepository: - type: string - dockerImageTag: - type: string - documentationUrl: - type: string - format: uri - icon: - type: string - resourceRequirements: - $ref: "#/components/schemas/ActorDefinitionResourceRequirements" - DestinationDefinitionUpdate: - type: object - required: - - destinationDefinitionId - - dockerImageag - properties: - destinationDefinitionId: - $ref: "#/components/schemas/DestinationDefinitionId" - dockerImageTag: - type: string - resourceRequirements: - $ref: "#/components/schemas/ActorDefinitionResourceRequirements" - DestinationDefinitionRead: - type: object - required: - - destinationDefinitionId - - name - - dockerRepository - - dockerImageTag - - documentationUrl - - supportsDbt - - normalizationConfig - properties: - destinationDefinitionId: - $ref: "#/components/schemas/DestinationDefinitionId" - name: - type: string - dockerRepository: - type: string - dockerImageTag: - type: string - documentationUrl: - type: string - format: uri - icon: - type: string - protocolVersion: - description: The Airbyte Protocol version supported by the connector - type: string - releaseStage: - $ref: "#/components/schemas/ReleaseStage" - releaseDate: - description: The date when this connector was first released, in yyyy-mm-dd format. - type: string - format: date - resourceRequirements: - $ref: "#/components/schemas/ActorDefinitionResourceRequirements" - supportsDbt: - type: boolean - description: an optional flag indicating whether DBT is used in the normalization. If the flag value is NULL - DBT is not used. - normalizationConfig: - $ref: "#/components/schemas/NormalizationDestinationDefinitionConfig" - - DestinationDefinitionReadList: - type: object - required: - - destinationDefinitions - properties: - destinationDefinitions: - type: array - items: - $ref: "#/components/schemas/DestinationDefinitionRead" - CustomDestinationDefinitionCreate: - type: object - required: - - workspaceId - - destinationDefinition - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - destinationDefinition: - $ref: "#/components/schemas/DestinationDefinitionCreate" - DestinationDefinitionIdWithWorkspaceId: - type: object - required: - - destinationDefinitionId - - workspaceId - properties: - destinationDefinitionId: - $ref: "#/components/schemas/DestinationDefinitionId" - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - PrivateDestinationDefinitionRead: - type: object - required: - - destinationDefinition - - granted - properties: - destinationDefinition: - $ref: "#/components/schemas/DestinationDefinitionRead" - granted: - type: boolean - PrivateDestinationDefinitionReadList: - type: object - required: - - destinationDefinitions - properties: - destinationDefinitions: - type: array - items: - $ref: "#/components/schemas/PrivateDestinationDefinitionRead" - # DESTINATION DEFINITION SPECIFICATION - DestinationDefinitionSpecification: - description: The specification for what values are required to configure the destinationDefinition. - type: object - example: { user: { type: string } } - DestinationDefinitionSpecificationRead: - type: object - required: - - destinationDefinitionId - - jobInfo - properties: - destinationDefinitionId: - $ref: "#/components/schemas/DestinationDefinitionId" - documentationUrl: - type: string - connectionSpecification: - $ref: "#/components/schemas/DestinationDefinitionSpecification" - advancedAuth: - $ref: "#/components/schemas/AdvancedAuth" - jobInfo: - $ref: "#/components/schemas/SynchronousJobRead" - supportedDestinationSyncModes: - type: array - items: - $ref: "#/components/schemas/DestinationSyncMode" - # DESTINATION - DestinationId: - type: string - format: uuid - DestinationIdRequestBody: - type: object - required: - - destinationId - properties: - destinationId: - $ref: "#/components/schemas/DestinationId" - DestinationConfiguration: - description: The values required to configure the destination. The schema for this must match the schema return by destination_definition_specifications/get for the destinationDefinition. - example: { user: "charles" } - DestinationCoreConfig: - type: object - required: - - workspaceId - - destinationDefinitionId - - connectionConfiguration - properties: - destinationId: - $ref: "#/components/schemas/DestinationId" - destinationDefinitionId: - $ref: "#/components/schemas/DestinationDefinitionId" - connectionConfiguration: - $ref: "#/components/schemas/DestinationConfiguration" - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - DestinationCreate: - type: object - required: - - name - - workspaceId - - destinationDefinitionId - - connectionConfiguration - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - name: - type: string - destinationDefinitionId: - $ref: "#/components/schemas/DestinationDefinitionId" - connectionConfiguration: - $ref: "#/components/schemas/DestinationConfiguration" - DestinationUpdate: - type: object - required: - - destinationId - - connectionConfiguration - - name - properties: - destinationId: - $ref: "#/components/schemas/DestinationId" - connectionConfiguration: - $ref: "#/components/schemas/DestinationConfiguration" - name: - type: string - PartialDestinationUpdate: - type: object - properties: - destinationId: - $ref: "#/components/schemas/DestinationId" - connectionConfiguration: - $ref: "#/components/schemas/DestinationConfiguration" - name: - type: string - DestinationCloneRequestBody: - description: The values required to configure the destination. The schema for this should have an id of the existing destination along with the configuration you want to change in case. - type: object - required: - - destinationCloneId - properties: - destinationCloneId: - $ref: "#/components/schemas/DestinationId" - destinationConfiguration: - $ref: "#/components/schemas/DestinationCloneConfiguration" - DestinationCloneConfiguration: - type: object - properties: - connectionConfiguration: - $ref: "#/components/schemas/DestinationConfiguration" - name: - type: string - DestinationRead: - type: object - required: - - destinationDefinitionId - - destinationId - - workspaceId - - connectionConfiguration - - name - - destinationName - properties: - destinationDefinitionId: - $ref: "#/components/schemas/DestinationDefinitionId" - destinationId: - $ref: "#/components/schemas/DestinationId" - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - connectionConfiguration: - $ref: "#/components/schemas/DestinationConfiguration" - name: - type: string - destinationName: - type: string - icon: - type: string - DestinationSnippetRead: - type: object - required: - - destinationId - - name - - destinationDefinitionId - - destinationName - properties: - destinationId: - $ref: "#/components/schemas/DestinationId" - name: - type: string - destinationDefinitionId: - $ref: "#/components/schemas/DestinationDefinitionId" - destinationName: - type: string - icon: - type: string - DestinationReadList: - type: object - required: - - destinations - properties: - destinations: - type: array - items: - $ref: "#/components/schemas/DestinationRead" - DestinationSearch: - type: object - properties: - destinationDefinitionId: - $ref: "#/components/schemas/DestinationDefinitionId" - destinationId: - $ref: "#/components/schemas/DestinationId" - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - connectionConfiguration: - $ref: "#/components/schemas/DestinationConfiguration" - name: - type: string - destinationName: - type: string - # SOURCE / DESTINATION RELEASE STAGE ENUM - ReleaseStage: - type: string - enum: - - alpha - - beta - - generally_available - - custom - # CONNECTION - ConnectionId: - type: string - format: uuid - ConnectionIdRequestBody: - type: object - required: - - connectionId - properties: - connectionId: - $ref: "#/components/schemas/ConnectionId" - ConnectionStream: - type: object - required: - - streamName - - streamNamespace - properties: - streamName: - type: string - streamNamespace: - type: string - ConnectionStreamRequestBody: - type: object - required: - - connectionId - - streams - properties: - connectionId: - $ref: "#/components/schemas/ConnectionId" - streams: - type: array - items: - $ref: "#/components/schemas/ConnectionStream" - DbMigrationRequestBody: - type: object - required: - - database - properties: - database: - type: string - WebBackendConnectionRequestBody: - type: object - required: - - connectionId - properties: - withRefreshedCatalog: - type: boolean - connectionId: - $ref: "#/components/schemas/ConnectionId" - ConnectionCreate: - type: object - required: - - sourceId - - destinationId - - status - properties: - name: - type: string - description: Optional name of the connection - namespaceDefinition: - $ref: "#/components/schemas/NamespaceDefinitionType" - namespaceFormat: - type: string - description: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. - default: null - example: "${SOURCE_NAMESPACE}" - prefix: - type: string - description: Prefix that will be prepended to the name of each stream when it is written to the destination. - sourceId: - $ref: "#/components/schemas/SourceId" - destinationId: - $ref: "#/components/schemas/DestinationId" - operationIds: - type: array - items: - $ref: "#/components/schemas/OperationId" - syncCatalog: - $ref: "#/components/schemas/AirbyteCatalog" - schedule: - $ref: "#/components/schemas/ConnectionSchedule" - scheduleType: - $ref: "#/components/schemas/ConnectionScheduleType" - scheduleData: - $ref: "#/components/schemas/ConnectionScheduleData" - status: - $ref: "#/components/schemas/ConnectionStatus" - resourceRequirements: - $ref: "#/components/schemas/ResourceRequirements" - sourceCatalogId: - type: string - format: uuid - geography: - $ref: "#/components/schemas/Geography" - notifySchemaChanges: - type: boolean - notifySchemaChangesByEmail: - type: boolean - nonBreakingChangesPreference: - $ref: "#/components/schemas/NonBreakingChangesPreference" - WebBackendConnectionCreate: - type: object - required: - - sourceId - - destinationId - - status - properties: - name: - type: string - description: Optional name of the connection - namespaceDefinition: - $ref: "#/components/schemas/NamespaceDefinitionType" - namespaceFormat: - type: string - description: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. - default: null - example: "${SOURCE_NAMESPACE}" - prefix: - type: string - description: Prefix that will be prepended to the name of each stream when it is written to the destination. - sourceId: - $ref: "#/components/schemas/SourceId" - destinationId: - $ref: "#/components/schemas/DestinationId" - operationIds: - type: array - items: - $ref: "#/components/schemas/OperationId" - syncCatalog: - $ref: "#/components/schemas/AirbyteCatalog" - schedule: - $ref: "#/components/schemas/ConnectionSchedule" - scheduleType: - $ref: "#/components/schemas/ConnectionScheduleType" - scheduleData: - $ref: "#/components/schemas/ConnectionScheduleData" - status: - $ref: "#/components/schemas/ConnectionStatus" - resourceRequirements: - $ref: "#/components/schemas/ResourceRequirements" - operations: - type: array - items: - $ref: "#/components/schemas/OperationCreate" - sourceCatalogId: - type: string - format: uuid - geography: - $ref: "#/components/schemas/Geography" - nonBreakingChangesPreference: - $ref: "#/components/schemas/NonBreakingChangesPreference" - ConnectionStateCreateOrUpdate: - type: object - required: - - connectionId - - connectionState - properties: - connectionId: - $ref: "#/components/schemas/ConnectionId" - connectionState: - $ref: "#/components/schemas/ConnectionState" - ConnectionUpdate: - type: object - description: Used to apply a patch-style update to a connection, which means that null properties remain unchanged - required: - - connectionId - properties: - connectionId: - $ref: "#/components/schemas/ConnectionId" - namespaceDefinition: - $ref: "#/components/schemas/NamespaceDefinitionType" - namespaceFormat: - type: string - description: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. - default: null - example: "${SOURCE_NAMESPACE}" - name: - type: string - description: Name that will be set to this connection - prefix: - type: string - description: Prefix that will be prepended to the name of each stream when it is written to the destination. - operationIds: - type: array - items: - $ref: "#/components/schemas/OperationId" - syncCatalog: - $ref: "#/components/schemas/AirbyteCatalog" - schedule: - $ref: "#/components/schemas/ConnectionSchedule" - scheduleType: - $ref: "#/components/schemas/ConnectionScheduleType" - scheduleData: - $ref: "#/components/schemas/ConnectionScheduleData" - status: - $ref: "#/components/schemas/ConnectionStatus" - resourceRequirements: - $ref: "#/components/schemas/ResourceRequirements" - sourceCatalogId: - type: string - format: uuid - geography: - $ref: "#/components/schemas/Geography" - notifySchemaChanges: - type: boolean - notifySchemaChangesByEmail: - type: boolean - nonBreakingChangesPreference: - $ref: "#/components/schemas/NonBreakingChangesPreference" - breakingChange: - type: boolean - WebBackendConnectionUpdate: - type: object - description: Used to apply a patch-style update to a connection, which means that null properties remain unchanged - required: - - connectionId - properties: - name: - type: string - description: Name that will be set to the connection - connectionId: - $ref: "#/components/schemas/ConnectionId" - namespaceDefinition: - $ref: "#/components/schemas/NamespaceDefinitionType" - namespaceFormat: - type: string - description: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. - default: null - example: "${SOURCE_NAMESPACE}" - prefix: - type: string - description: Prefix that will be prepended to the name of each stream when it is written to the destination. - syncCatalog: - $ref: "#/components/schemas/AirbyteCatalog" - schedule: - $ref: "#/components/schemas/ConnectionSchedule" - scheduleType: - $ref: "#/components/schemas/ConnectionScheduleType" - scheduleData: - $ref: "#/components/schemas/ConnectionScheduleData" - status: - $ref: "#/components/schemas/ConnectionStatus" - resourceRequirements: - $ref: "#/components/schemas/ResourceRequirements" - skipReset: - type: boolean - operations: - type: array - items: - $ref: "#/components/schemas/WebBackendOperationCreateOrUpdate" - sourceCatalogId: - type: string - format: uuid - geography: - $ref: "#/components/schemas/Geography" - notifySchemaChanges: - type: boolean - notifySchemaChangesByEmail: - type: boolean - nonBreakingChangesPreference: - $ref: "#/components/schemas/NonBreakingChangesPreference" - ConnectionRead: - type: object - required: - - connectionId - - name - - sourceId - - destinationId - - syncCatalog - - status - - breakingChange - properties: - connectionId: - $ref: "#/components/schemas/ConnectionId" - name: - type: string - namespaceDefinition: - $ref: "#/components/schemas/NamespaceDefinitionType" - namespaceFormat: - type: string - description: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. - default: null - example: "${SOURCE_NAMESPACE}" - prefix: - type: string - description: Prefix that will be prepended to the name of each stream when it is written to the destination. - sourceId: - $ref: "#/components/schemas/SourceId" - destinationId: - $ref: "#/components/schemas/DestinationId" - operationIds: - type: array - items: - $ref: "#/components/schemas/OperationId" - syncCatalog: - $ref: "#/components/schemas/AirbyteCatalog" - schedule: - $ref: "#/components/schemas/ConnectionSchedule" - scheduleType: - $ref: "#/components/schemas/ConnectionScheduleType" - scheduleData: - $ref: "#/components/schemas/ConnectionScheduleData" - status: - $ref: "#/components/schemas/ConnectionStatus" - resourceRequirements: - $ref: "#/components/schemas/ResourceRequirements" - sourceCatalogId: - type: string - format: uuid - geography: - $ref: "#/components/schemas/Geography" - breakingChange: - type: boolean - notifySchemaChanges: - type: boolean - notifySchemaChangesByEmail: - type: boolean - nonBreakingChangesPreference: - $ref: "#/components/schemas/NonBreakingChangesPreference" - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - SchemaChange: - enum: - - no_change - - non_breaking - - breaking - type: string - ConnectionSearch: - type: object - properties: - connectionId: - $ref: "#/components/schemas/ConnectionId" - name: - type: string - namespaceDefinition: - $ref: "#/components/schemas/NamespaceDefinitionType" - namespaceFormat: - type: string - description: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. - default: null - example: "${SOURCE_NAMESPACE}" - prefix: - type: string - description: Prefix that will be prepended to the name of each stream when it is written to the destination. - sourceId: - $ref: "#/components/schemas/SourceId" - destinationId: - $ref: "#/components/schemas/DestinationId" - schedule: - $ref: "#/components/schemas/ConnectionSchedule" - scheduleType: - $ref: "#/components/schemas/ConnectionScheduleType" - scheduleData: - $ref: "#/components/schemas/ConnectionScheduleData" - status: - $ref: "#/components/schemas/ConnectionStatus" - source: - $ref: "#/components/schemas/SourceSearch" - destination: - $ref: "#/components/schemas/DestinationSearch" - ConnectionReadList: - type: object - required: - - connections - properties: - connections: - type: array - items: - $ref: "#/components/schemas/ConnectionRead" - ConnectionStatus: - type: string - description: Active means that data is flowing through the connection. Inactive means it is not. Deprecated means the connection is off and cannot be re-activated. the schema field describes the elements of the schema that will be synced. - enum: - - active - - inactive - - deprecated - # TODO(https://github.com/airbytehq/airbyte/issues/11432): remove. - # Prefer the ConnectionScheduleType and ConnectionScheduleData properties. - ConnectionSchedule: - description: if null, then no schedule is set. - type: object - required: - - units - - timeUnit - properties: - units: - type: integer - format: int64 - timeUnit: - type: string - enum: - - minutes - - hours - - days - - weeks - - months - ConnectionScheduleType: - description: determine how the schedule data should be interpreted - type: string - enum: - - manual - - basic - - cron - ConnectionScheduleData: - description: schedule for when the the connection should run, per the schedule type - type: object - properties: - # This should be populated when schedule type is basic. - basicSchedule: - type: object - required: - - timeUnit - - units - properties: - timeUnit: - type: string - enum: - - minutes - - hours - - days - - weeks - - months - units: - type: integer - format: int64 - # This should be populated when schedule type is cron. - cron: - type: object - required: - - cronExpression - - cronTimeZone - properties: - cronExpression: - type: string - cronTimeZone: - type: string - NamespaceDefinitionType: - type: string - description: Method used for computing final namespace in destination - enum: - - source - - destination - - customformat - # Operations - OperationId: - type: string - format: uuid - OperationIdRequestBody: - type: object - required: - - operationId - properties: - operationId: - $ref: "#/components/schemas/OperationId" - OperationCreate: - type: object - required: - - name - - operatorConfiguration - - workspaceId - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - name: - type: string - operatorConfiguration: - $ref: "#/components/schemas/OperatorConfiguration" - OperationUpdate: - type: object - required: - - operationId - - name - - operatorConfiguration - properties: - operationId: - $ref: "#/components/schemas/OperationId" - name: - type: string - operatorConfiguration: - $ref: "#/components/schemas/OperatorConfiguration" - WebBackendOperationCreateOrUpdate: - type: object - required: - - name - - operatorConfiguration - - workspaceId - properties: - operationId: - $ref: "#/components/schemas/OperationId" - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - name: - type: string - operatorConfiguration: - $ref: "#/components/schemas/OperatorConfiguration" - OperationRead: - type: object - required: - - operationId - - name - - operatorConfiguration - - workspaceId - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - operationId: - $ref: "#/components/schemas/OperationId" - name: - type: string - operatorConfiguration: - $ref: "#/components/schemas/OperatorConfiguration" - OperationReadList: - type: object - required: - - operations - properties: - operations: - type: array - items: - $ref: "#/components/schemas/OperationRead" - OperatorConfiguration: - type: object - required: - - operatorType - properties: - # Instead of this type field, we would prefer a json schema "oneOf" but unfortunately, - # the jsonschema2pojo does not seem to support it yet: https://github.com/joelittlejohn/jsonschema2pojo/issues/392 - operatorType: - $ref: "#/components/schemas/OperatorType" - normalization: - $ref: "#/components/schemas/OperatorNormalization" - dbt: - $ref: "#/components/schemas/OperatorDbt" - webhook: - $ref: "#/components/schemas/OperatorWebhook" - OperatorType: - type: string - enum: - # - destination - - normalization - - dbt - - webhook - # - docker - OperatorNormalization: - type: object - properties: - option: - type: string - enum: - - basic - #- unnesting - OperatorDbt: - type: object - required: - - gitRepoUrl - properties: - gitRepoUrl: - type: string - gitRepoBranch: - type: string - dockerImage: - type: string - dbtArguments: - type: string - OperatorWebhook: - type: object - properties: - webhookConfigId: - type: string - format: uuid - description: The id of the webhook configs to use from the workspace. - webhookType: - type: string - enum: - - dbtCloud - dbtCloud: - type: object - required: - - accountId - - jobId - properties: - accountId: - type: integer - description: The account id associated with the job - jobId: - type: integer - description: The job id associated with the job - executionUrl: - type: string - description: DEPRECATED. Populate dbtCloud instead. - deprecated: true - executionBody: - type: string - description: DEPRECATED. Populate dbtCloud instead. - deprecated: true - CheckOperationRead: - type: object - required: - - status - properties: - status: - type: string - enum: - - succeeded - - failed - message: - type: string - # LOGS - LogType: - type: string - description: type/source of logs produced - enum: - - server - - scheduler - LogsRequestBody: - type: object - required: - - logType - properties: - logType: - $ref: "#/components/schemas/LogType" - # ACTOR CATALOG - ActorCatalogWithUpdatedAt: - description: A source actor catalog with the timestamp it was mostly recently updated - type: object - properties: - updatedAt: - type: integer - format: int64 - catalog: - type: object - # SCHEMA CATALOG - AirbyteCatalog: - description: describes the available schema (catalog). - type: object - required: - - streams - properties: - streams: - type: array - items: - $ref: "#/components/schemas/AirbyteStreamAndConfiguration" - AirbyteStreamAndConfiguration: - description: each stream is split in two parts; the immutable schema from source and mutable configuration for destination - type: object - additionalProperties: false - properties: - stream: - $ref: "#/components/schemas/AirbyteStream" - config: - $ref: "#/components/schemas/AirbyteStreamConfiguration" - AirbyteStream: - description: the immutable schema defined by the source - type: object - additionalProperties: false - required: - - name - - json_schema - # todo (cgardens) - make required once sources are migrated - # - supported_sync_modes - properties: - name: - type: string - description: Stream's name. - jsonSchema: - $ref: "#/components/schemas/StreamJsonSchema" - supportedSyncModes: - type: array - items: - $ref: "#/components/schemas/SyncMode" - sourceDefinedCursor: - description: If the source defines the cursor field, then any other cursor field inputs will be ignored. If it does not, either the user_provided one is used, or the default one is used as a backup. - type: boolean - defaultCursorField: - description: Path to the field that will be used to determine if a record is new or modified since the last sync. If not provided by the source, the end user will have to specify the comparable themselves. - type: array - items: - type: string - sourceDefinedPrimaryKey: - description: If the source defines the primary key, paths to the fields that will be used as a primary key. If not provided by the source, the end user will have to specify the primary key themselves. - type: array - items: - type: array - items: - type: string - namespace: - type: string - description: Optional Source-defined namespace. Airbyte streams from the same sources should have the same namespace. Currently only used by JDBC destinations to determine what schema to write to. - StreamJsonSchema: - description: Stream schema using Json Schema specs. - type: object - AirbyteStreamConfiguration: - description: the mutable part of the stream to configure the destination - type: object - additionalProperties: false - required: - - syncMode - - destinationSyncMode - properties: - syncMode: - $ref: "#/components/schemas/SyncMode" - cursorField: - description: Path to the field that will be used to determine if a record is new or modified since the last sync. This field is REQUIRED if `sync_mode` is `incremental`. Otherwise it is ignored. - type: array - items: - type: string - destinationSyncMode: - $ref: "#/components/schemas/DestinationSyncMode" - primaryKey: - description: Paths to the fields that will be used as primary key. This field is REQUIRED if `destination_sync_mode` is `*_dedup`. Otherwise it is ignored. - type: array - items: - type: array - items: - type: string - aliasName: - description: Alias name to the stream to be used in the destination - type: string - selected: - description: If this is true, the stream is selected with all of its properties. For new connections, this considers if the stream is suggested or not - type: boolean - suggested: - description: Does the connector suggest that this stream be enabled by default? - type: boolean - fieldSelectionEnabled: - description: Whether field selection should be enabled. If this is true, only the properties in `selectedFields` will be included. - type: boolean - selectedFields: - description: Paths to the fields that will be included in the configured catalog. This must be set if `fieldSelectedEnabled` is set. An empty list indicates that no properties will be included. - type: array - items: - $ref: "#/components/schemas/SelectedFieldInfo" - SelectedFieldInfo: - type: object - # TODO(mfsiega-airbyte): point to thorough documentation on nested fields and paths. - description: Path to a field/column/property in a stream to be selected. For example, if the field to be selected is a database column called "foo", this will be ["foo"]. Use multiple path elements for nested schemas. - properties: - fieldPath: - type: array - items: - type: string - DataType: - type: string - enum: - - string - - number - - boolean - - object - - array - # SCHEDULER - JobId: - type: integer - format: int64 - JobConfigType: - type: string - enum: - - check_connection_source - - check_connection_destination - - discover_schema - - get_spec - - sync - - reset_connection - JobListRequestBody: - type: object - required: - - configTypes - - configId - properties: - configTypes: - type: array - items: - $ref: "#/components/schemas/JobConfigType" - configId: - type: string - includingJobId: - description: If the job with this ID exists for the specified connection, returns the number of pages of jobs necessary to include this job. Returns an empty list if this job is specified and cannot be found in this connection. - $ref: "#/components/schemas/JobId" - pagination: - $ref: "#/components/schemas/Pagination" - JobIdRequestBody: - type: object - required: - - id - properties: - id: - $ref: "#/components/schemas/JobId" - JobRead: - type: object - required: - - id - - configType - - configId - - createdAt - - updatedAt - - status - properties: - id: - $ref: "#/components/schemas/JobId" - configType: - $ref: "#/components/schemas/JobConfigType" - configId: - type: string - enabledStreams: - type: array - items: - $ref: "#/components/schemas/StreamDescriptor" - createdAt: - type: integer - format: int64 - updatedAt: - type: integer - format: int64 - startedAt: - type: integer - format: int64 - status: - $ref: "#/components/schemas/JobStatus" - resetConfig: - $ref: "#/components/schemas/ResetConfig" - ResetConfig: - type: object - description: contains information about how a reset was configured. only populated if the job was a reset. - properties: - streamsToReset: - type: array - items: - $ref: "#/components/schemas/StreamDescriptor" - StreamDescriptor: - type: object - required: - - name - properties: - name: - type: string - namespace: - type: string - JobDebugRead: - type: object - required: - - id - - configType - - configId - - status - - airbyteVersion - - sourceDefinition - - destinationDefinition - properties: - id: - $ref: "#/components/schemas/JobId" - configType: - $ref: "#/components/schemas/JobConfigType" - configId: - type: string - status: - $ref: "#/components/schemas/JobStatus" - airbyteVersion: - type: string - sourceDefinition: - $ref: "#/components/schemas/SourceDefinitionRead" - destinationDefinition: - $ref: "#/components/schemas/DestinationDefinitionRead" - WorkflowStateRead: - type: object - required: - - running - properties: - running: - type: boolean - JobWithAttemptsRead: - type: object - properties: - job: - $ref: "#/components/schemas/JobRead" - attempts: - type: array - items: - $ref: "#/components/schemas/AttemptRead" - JobCreatedAt: - description: epoch time of the latest sync job. null if no sync job has taken place. - type: integer - format: int64 - JobStatus: - type: string - enum: - - pending - - running - - incomplete - - failed - - succeeded - - cancelled - AttemptRead: - type: object - required: - - id - - status - - createdAt - - updatedAt - properties: - id: - type: integer - format: int64 - status: - $ref: "#/components/schemas/AttemptStatus" - createdAt: - type: integer - format: int64 - updatedAt: - type: integer - format: int64 - endedAt: - type: integer - format: int64 - bytesSynced: - type: integer - format: int64 - recordsSynced: - type: integer - format: int64 - totalStats: - $ref: "#/components/schemas/AttemptStats" - streamStats: - type: array - items: - $ref: "#/components/schemas/AttemptStreamStats" - failureSummary: - $ref: "#/components/schemas/AttemptFailureSummary" - AttemptStats: - type: object - properties: - recordsEmitted: - type: integer - format: int64 - bytesEmitted: - type: integer - format: int64 - stateMessagesEmitted: - type: integer - format: int64 - bytesCommitted: - type: integer - format: int64 - recordsCommitted: - type: integer - format: int64 - estimatedRecords: - type: integer - format: int64 - estimatedBytes: - type: integer - format: int64 - AttemptStreamStats: - type: object - required: - - streamName - - stats - properties: - streamName: - type: string - streamNamespace: - type: string - stats: - $ref: "#/components/schemas/AttemptStats" - AttemptFailureSummary: - type: object - required: - - failures - properties: - failures: - type: array - items: - $ref: "#/components/schemas/FailureReason" - partialSuccess: - description: True if the number of committed records for this attempt was greater than 0. False if 0 records were committed. If not set, the number of committed records is unknown. - type: boolean - FailureReason: - type: object - required: - - timestamp - properties: - failureOrigin: - $ref: "#/components/schemas/FailureOrigin" - failureType: - $ref: "#/components/schemas/FailureType" - externalMessage: - type: string - internalMessage: - type: string - stacktrace: - type: string - retryable: - description: True if it is known that retrying may succeed, e.g. for a transient failure. False if it is known that a retry will not succeed, e.g. for a configuration issue. If not set, retryable status is not well known. - type: boolean - timestamp: - type: integer - format: int64 - FailureOrigin: - description: Indicates where the error originated. If not set, the origin of error is not well known. - type: string - enum: - - source - - destination - - replication - - persistence - - normalization - - dbt - - airbyte_platform - - unknown - FailureType: - description: Categorizes well known errors into types for programmatic handling. If not set, the type of error is not well known. - type: string - enum: - - config_error - - system_error - - manual_cancellation - - refresh_schema - - heartbeat_timeout - AttemptStatus: - type: string - enum: - - running - - failed - - succeeded - JobReadList: - type: object - required: - - jobs - - totalJobCount - properties: - jobs: - type: array - items: - $ref: "#/components/schemas/JobWithAttemptsRead" - totalJobCount: - description: the total count of jobs for the specified connection - type: integer - format: int64 - JobInfoRead: - type: object - required: - - job - - attempts - properties: - job: - $ref: "#/components/schemas/JobRead" - attempts: - type: array - items: - $ref: "#/components/schemas/AttemptInfoRead" - JobInfoLightRead: - type: object - required: - - job - properties: - job: - $ref: "#/components/schemas/JobRead" - JobOptionalRead: - type: object - properties: - job: - $ref: "#/components/schemas/JobRead" - JobDebugInfoRead: - type: object - required: - - job - - attempts - properties: - job: - $ref: "#/components/schemas/JobDebugRead" - attempts: - type: array - items: - $ref: "#/components/schemas/AttemptInfoRead" - workflowState: - $ref: "#/components/schemas/WorkflowStateRead" - AttemptInfoRead: - type: object - required: - - attempt - - logs - properties: - attempt: - $ref: "#/components/schemas/AttemptRead" - logs: - $ref: "#/components/schemas/LogRead" - LogRead: - type: object - required: - - logLines - properties: - logLines: - type: array - items: - type: string - SynchronousJobRead: - type: object - required: - - id - - configType - - createdAt - - endedAt - - succeeded - properties: - id: - type: string - format: uuid - configType: - $ref: "#/components/schemas/JobConfigType" - configId: - description: only present if a config id was provided. - type: string - createdAt: - type: integer - format: int64 - endedAt: - type: integer - format: int64 - succeeded: - type: boolean - connectorConfigurationUpdated: - type: boolean - default: false - logs: - $ref: "#/components/schemas/LogRead" - failureReason: - $ref: "#/components/schemas/FailureReason" - Pagination: - type: object - properties: - pageSize: - type: integer - rowOffset: - type: integer - # Health - HealthCheckRead: - type: object - required: - - available - properties: - available: - type: boolean - # General - CheckConnectionRead: - type: object - required: - - jobInfo - properties: - status: - type: string - enum: - - succeeded - - failed - message: - type: string - jobInfo: - $ref: "#/components/schemas/SynchronousJobRead" - ConnectionState: - type: object - description: Contains the state for a connection. The stateType field identifies what type of state it is. Only the field corresponding to that type will be set, the rest will be null. If stateType=not_set, then none of the fields will be set. - required: - - connectionId - - stateType - properties: - stateType: - $ref: "#/components/schemas/ConnectionStateType" - connectionId: - $ref: "#/components/schemas/ConnectionId" - state: # legacy state object - $ref: "#/components/schemas/StateBlob" - streamState: - type: array - items: - $ref: "#/components/schemas/StreamState" - globalState: - $ref: "#/components/schemas/GlobalState" - StateBlob: - type: object - StreamState: - type: object - required: - - streamDescriptor - properties: - streamDescriptor: - $ref: "#/components/schemas/StreamDescriptor" - streamState: - $ref: "#/components/schemas/StateBlob" - GlobalState: - type: object - required: - - streamStates - properties: - shared_state: - $ref: "#/components/schemas/StateBlob" - streamStates: - type: array - items: - $ref: "#/components/schemas/StreamState" - ConnectionStateType: - type: string - enum: - - global - - stream - - legacy - - not_set - CatalogDiff: - type: object - description: Describes the difference between two Airbyte catalogs. - required: - - transforms - properties: - transforms: - description: list of stream transformations. order does not matter. - type: array - items: - $ref: "#/components/schemas/StreamTransform" - StreamTransform: - type: object - required: - - transformType - - streamDescriptor - properties: - transformType: - type: string - enum: - - add_stream - - remove_stream - - update_stream - streamDescriptor: - $ref: "#/components/schemas/StreamDescriptor" - updateStream: - type: array - description: list of field transformations. order does not matter. - items: - $ref: "#/components/schemas/FieldTransform" - FieldTransform: - type: object - description: "Describes the difference between two Streams." - required: - - transformType - - fieldName - - breaking - properties: - transformType: - type: string - enum: - - add_field - - remove_field - - update_field_schema - fieldName: - $ref: "#/components/schemas/FieldName" - breaking: - type: boolean - addField: - $ref: "#/components/schemas/FieldAdd" - removeField: - $ref: "#/components/schemas/FieldRemove" - updateFieldSchema: - $ref: "#/components/schemas/FieldSchemaUpdate" - FieldAdd: - type: object - properties: - schema: - $ref: "#/components/schemas/FieldSchema" - FieldRemove: - type: object - properties: - schema: - $ref: "#/components/schemas/FieldSchema" - FieldSchemaUpdate: - type: object - required: - - oldSchema - - newSchema - properties: - oldSchema: - $ref: "#/components/schemas/FieldSchema" - newSchema: - $ref: "#/components/schemas/FieldSchema" - FieldName: - description: A field name is a list of strings that form the path to the field. - type: array - items: - type: string - FieldSchema: - description: JSONSchema representation of the field - type: object - ActorDefinitionResourceRequirements: - description: actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level. - type: object - additionalProperties: false - properties: - default: - "$ref": "#/components/schemas/ResourceRequirements" - jobSpecific: - type: array - items: - "$ref": "#/components/schemas/JobTypeResourceLimit" - ActorDefinitionRequestBody: - type: object - additionalProperties: false - required: - - actorDefinitionId - - actorType - properties: - actorDefinitionId: - type: string - format: uuid - actorType: - $ref: "#/components/schemas/ActorType" - NormalizationDestinationDefinitionConfig: - description: describes a normalization config for destination definition - type: object - required: - - supported - additionalProperties: false - properties: - supported: - type: boolean - description: whether the destination definition supports normalization. - default: false - normalizationRepository: - type: string - description: a field indicating the name of the repository to be used for normalization. If the value of the flag is NULL - normalization is not used. - normalizationTag: - type: string - description: a field indicating the tag of the docker repository to be used for normalization. - normalizationIntegrationType: - type: string - description: a field indicating the type of integration dialect to use for normalization. - - JobTypeResourceLimit: - description: sets resource requirements for a specific job type for an actor definition. these values override the default, if both are set. - type: object - additionalProperties: false - required: - - jobType - - resourceRequirements - properties: - jobType: - "$ref": "#/components/schemas/JobType" - resourceRequirements: - "$ref": "#/components/schemas/ResourceRequirements" - JobType: - description: enum that describes the different types of jobs that the platform runs. - type: string - enum: - - get_spec - - check_connection - - discover_schema - - sync - - reset_connection - - connection_updater - - replicate - ResourceRequirements: - description: optional resource requirements to run workers (blank for unbounded allocations) - type: object - properties: - cpu_request: - type: string - cpu_limit: - type: string - memory_request: - type: string - memory_limit: - type: string - # DB Migration - DbMigrationState: - type: string - # https://github.com/flyway/flyway/blob/master/flyway-core/src/main/java/org/flywaydb/core/api/MigrationState.java - enum: - - pending - - above_target - - below_baseline - - baseline - - ignored - - missing_success - - missing_failed - - success - - undone - - available - - failed - - out_of_order - - future_success - - future_failed - - outdated - - superseded - - deleted - DbMigrationRead: - type: object - required: - - migrationType - - migrationVersion - - migrationDescription - properties: - migrationType: - type: string - migrationVersion: - type: string - migrationDescription: - type: string - migrationState: - $ref: "#/components/schemas/DbMigrationState" - migratedBy: - type: string - migratedAt: - type: integer - format: int64 - migrationScript: - type: string - DbMigrationReadList: - type: object - properties: - migrations: - type: array - items: - $ref: "#/components/schemas/DbMigrationRead" - DbMigrationExecutionRead: - type: object - properties: - initialVersion: - type: string - targetVersion: - type: string - executedMigrations: - type: array - items: - $ref: "#/components/schemas/DbMigrationRead" - # OAuth - OAuthConfiguration: - description: The values required to configure OAuth flows. The schema for this must match the `OAuthConfigSpecification.oauthUserInputFromConnectorConfigSpecification` schema. - OAuthInputConfiguration: - $ref: "#/components/schemas/OAuthConfiguration" - AdvancedAuth: - type: object - properties: - authFlowType: - type: string - enum: ["oauth2.0", "oauth1.0"] - predicateKey: - description: Json Path to a field in the connectorSpecification that should exist for the advanced auth to be applicable. - type: array - items: - type: string - predicateValue: - description: Value of the predicate_key fields for the advanced auth to be applicable. - type: string - oauthConfigSpecification: - "$ref": "#/components/schemas/OAuthConfigSpecification" - OAuthConfigSpecification: - type: object - properties: - oauthUserInputFromConnectorConfigSpecification: - description: |- - OAuth specific blob. This is a Json Schema used to validate Json configurations used as input to OAuth. - Must be a valid non-nested JSON that refers to properties from ConnectorSpecification.connectionSpecification - using special annotation 'path_in_connector_config'. - These are input values the user is entering through the UI to authenticate to the connector, that might also shared - as inputs for syncing data via the connector. - - Examples: - - if no connector values is shared during oauth flow, oauth_user_input_from_connector_config_specification=[] - if connector values such as 'app_id' inside the top level are used to generate the API url for the oauth flow, - oauth_user_input_from_connector_config_specification={ - app_id: { - type: string - path_in_connector_config: ['app_id'] - } - } - if connector values such as 'info.app_id' nested inside another object are used to generate the API url for the oauth flow, - oauth_user_input_from_connector_config_specification={ - app_id: { - type: string - path_in_connector_config: ['info', 'app_id'] - } - } - $ref: "#/components/schemas/OAuthConfiguration" - completeOAuthOutputSpecification: - description: |- - OAuth specific blob. This is a Json Schema used to validate Json configurations produced by the OAuth flows as they are - returned by the distant OAuth APIs. - Must be a valid JSON describing the fields to merge back to `ConnectorSpecification.connectionSpecification`. - For each field, a special annotation `path_in_connector_config` can be specified to determine where to merge it, - - Examples: - - complete_oauth_output_specification={ - refresh_token: { - type: string, - path_in_connector_config: ['credentials', 'refresh_token'] - } - } - $ref: "#/components/schemas/OAuthConfiguration" - completeOAuthServerInputSpecification: - description: |- - OAuth specific blob. This is a Json Schema used to validate Json configurations persisted as Airbyte Server configurations. - Must be a valid non-nested JSON describing additional fields configured by the Airbyte Instance or Workspace Admins to be used by the - server when completing an OAuth flow (typically exchanging an auth code for refresh token). - - Examples: - - complete_oauth_server_input_specification={ - client_id: { - type: string - }, - client_secret: { - type: string - } - } - $ref: "#/components/schemas/OAuthConfiguration" - completeOAuthServerOutputSpecification: - description: |- - OAuth specific blob. This is a Json Schema used to validate Json configurations persisted as Airbyte Server configurations that - also need to be merged back into the connector configuration at runtime. - This is a subset configuration of `complete_oauth_server_input_specification` that filters fields out to retain only the ones that - are necessary for the connector to function with OAuth. (some fields could be used during oauth flows but not needed afterwards, therefore - they would be listed in the `complete_oauth_server_input_specification` but not `complete_oauth_server_output_specification`) - Must be a valid non-nested JSON describing additional fields configured by the Airbyte Instance or Workspace Admins to be used by the - connector when using OAuth flow APIs. - These fields are to be merged back to `ConnectorSpecification.connectionSpecification`. - For each field, a special annotation `path_in_connector_config` can be specified to determine where to merge it, - - Examples: - - complete_oauth_server_output_specification={ - client_id: { - type: string, - path_in_connector_config: ['credentials', 'client_id'] - }, - client_secret: { - type: string, - path_in_connector_config: ['credentials', 'client_secret'] - } - } - $ref: "#/components/schemas/OAuthConfiguration" - SourceOauthConsentRequest: - type: object - required: - - sourceDefinitionId - - workspaceId - - redirectUrl - properties: - sourceDefinitionId: - $ref: "#/components/schemas/SourceDefinitionId" - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - redirectUrl: - description: The url to redirect to after getting the user consent - type: string - oAuthInputConfiguration: - $ref: "#/components/schemas/OAuthInputConfiguration" - sourceId: - $ref: "#/components/schemas/SourceId" - DestinationOauthConsentRequest: - type: object - required: - - destinationDefinitionId - - workspaceId - - redirectUrl - properties: - destinationDefinitionId: - $ref: "#/components/schemas/DestinationDefinitionId" - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - redirectUrl: - description: The url to redirect to after getting the user consent - type: string - oAuthInputConfiguration: - $ref: "#/components/schemas/OAuthInputConfiguration" - destinationId: - $ref: "#/components/schemas/DestinationId" - OAuthConsentRead: - type: object - required: - - consentUrl - properties: - consentUrl: - type: string - CompleteSourceOauthRequest: - type: object - required: - - sourceDefinitionId - - workspaceId - properties: - sourceDefinitionId: - $ref: "#/components/schemas/SourceDefinitionId" - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - redirectUrl: - description: When completing OAuth flow to gain an access token, some API sometimes requires to verify that the app re-send the redirectUrl that was used when consent was given. - type: string - queryParams: - description: The query parameters present in the redirect URL after a user granted consent e.g auth code - type: object - additionalProperties: true # Oauth parameters like code, state, etc.. will be different per API so we don't specify them in advance - oAuthInputConfiguration: - $ref: "#/components/schemas/OAuthInputConfiguration" - returnSecretCoordinate: - type: boolean - description: If set to true, returns a secret coordinate which references the stored tokens. By default, returns raw tokens. - default: false - sourceId: - $ref: "#/components/schemas/SourceId" - RevokeSourceOauthTokensRequest: - type: object - required: - - sourceId - - sourceDefinitionId - - workspaceId - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - sourceId: - $ref: "#/components/schemas/SourceId" - sourceDefinitionId: - $ref: "#/components/schemas/SourceDefinitionId" - CompleteDestinationOAuthRequest: - type: object - required: - - destinationDefinitionId - - workspaceId - properties: - destinationDefinitionId: - $ref: "#/components/schemas/DestinationDefinitionId" - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - redirectUrl: - description: When completing OAuth flow to gain an access token, some API sometimes requires to verify that the app re-send the redirectUrl that was used when consent was given. - type: string - queryParams: - description: The query parameters present in the redirect URL after a user granted consent e.g auth code - type: object - additionalProperties: true # Oauth parameters like code, state, etc.. will be different per API so we don't specify them in advance - oAuthInputConfiguration: - $ref: "#/components/schemas/OAuthInputConfiguration" - destinationId: - $ref: "#/components/schemas/DestinationId" - CompleteOAuthResponse: - type: object - required: - - request_succeeded - - auth_payload - properties: - request_succeeded: - type: boolean - request_error: - type: string - auth_payload: - type: object - additionalProperties: true # Oauth parameters like refresh/access token etc.. will be different per API, so we don't specify them in advance - SetInstancewideSourceOauthParamsRequestBody: - type: object - required: - - sourceDefinitionId - - params - properties: - sourceDefinitionId: - $ref: "#/components/schemas/SourceDefinitionId" - params: - type: object - additionalProperties: true - SetInstancewideDestinationOauthParamsRequestBody: - type: object - required: - - destinationDefinitionId - - params - properties: - destinationDefinitionId: - $ref: "#/components/schemas/DestinationDefinitionId" - params: - type: object - additionalProperties: true - WorkspaceOverrideOauthParamsRequestBody: - type: object - required: - - definitionId - - params - - workspaceId - - actorType - properties: - definitionId: - type: string - format: uuid - params: - type: object - additionalProperties: true - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - actorType: - $ref: "#/components/schemas/ActorType" - ActorType: - enum: - - source - - destination - type: string - # Web Backend - WebBackendCheckUpdatesRead: - type: object - description: Summary of source and destination definitions that could be updated - required: - - destinationDefinitions - - sourceDefinitions - properties: - destinationDefinitions: - type: integer - sourceDefinitions: - type: integer - WebBackendConnectionListRequestBody: - type: object - required: - - workspaceId - properties: - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - sourceId: - type: array - items: - $ref: "#/components/schemas/SourceId" - destinationId: - type: array - items: - $ref: "#/components/schemas/DestinationId" - WebBackendConnectionListItem: - type: object - description: Information about a connection that shows up in the connection list view. - required: - - connectionId - - name - - source - - destination - - status - - isSyncing - - schemaChange - properties: - connectionId: - $ref: "#/components/schemas/ConnectionId" - name: - type: string - scheduleType: - $ref: "#/components/schemas/ConnectionScheduleType" - scheduleData: - $ref: "#/components/schemas/ConnectionScheduleData" - status: - $ref: "#/components/schemas/ConnectionStatus" - source: - $ref: "#/components/schemas/SourceSnippetRead" - destination: - $ref: "#/components/schemas/DestinationSnippetRead" - latestSyncJobCreatedAt: - $ref: "#/components/schemas/JobCreatedAt" - latestSyncJobStatus: - $ref: "#/components/schemas/JobStatus" - isSyncing: - type: boolean - schemaChange: - $ref: "#/components/schemas/SchemaChange" - WebBackendConnectionRead: - type: object - required: - - connectionId - - name - - sourceId - - destinationId - - syncCatalog - - status - - source - - destination - - isSyncing - - schemaChange - - notifySchemaChanges - - notifySchemaChangesByEmail - - nonBreakingChangesPreference - properties: - connectionId: - $ref: "#/components/schemas/ConnectionId" - name: - type: string - namespaceDefinition: - $ref: "#/components/schemas/NamespaceDefinitionType" - namespaceFormat: - type: string - description: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. - default: null - example: "${SOURCE_NAMESPACE}" - prefix: - type: string - description: Prefix that will be prepended to the name of each stream when it is written to the destination. - sourceId: - $ref: "#/components/schemas/SourceId" - destinationId: - $ref: "#/components/schemas/DestinationId" - syncCatalog: - $ref: "#/components/schemas/AirbyteCatalog" - schedule: - $ref: "#/components/schemas/ConnectionSchedule" - scheduleType: - $ref: "#/components/schemas/ConnectionScheduleType" - scheduleData: - $ref: "#/components/schemas/ConnectionScheduleData" - status: - $ref: "#/components/schemas/ConnectionStatus" - operationIds: - type: array - items: - $ref: "#/components/schemas/OperationId" - source: - $ref: "#/components/schemas/SourceRead" - destination: - $ref: "#/components/schemas/DestinationRead" - operations: - type: array - items: - $ref: "#/components/schemas/OperationRead" - latestSyncJobCreatedAt: - $ref: "#/components/schemas/JobCreatedAt" - latestSyncJobStatus: - $ref: "#/components/schemas/JobStatus" - isSyncing: - type: boolean - resourceRequirements: - $ref: "#/components/schemas/ResourceRequirements" - catalogId: - type: string - format: uuid - catalogDiff: - $ref: "#/components/schemas/CatalogDiff" - geography: - $ref: "#/components/schemas/Geography" - schemaChange: - $ref: "#/components/schemas/SchemaChange" - notifySchemaChanges: - type: boolean - notifySchemaChangesByEmail: - type: boolean - nonBreakingChangesPreference: - $ref: "#/components/schemas/NonBreakingChangesPreference" - NonBreakingChangesPreference: - enum: - - ignore # do nothing if we detect a schema change - - disable # disable the connection, pausing the sync - - propagate_columns # automatically propagate the changes on selected streams and continue syncing - - propagate_fully # automatically propagate the changes including new streams and continue syncing - type: string - WebBackendConnectionReadList: - type: object - required: - - connections - properties: - connections: - type: array - items: - $ref: "#/components/schemas/WebBackendConnectionListItem" - SyncMode: - type: string - enum: - - full_refresh - - incremental - DestinationSyncMode: - type: string - enum: - - append - - overwrite - #- upsert_dedup # TODO chris: SCD Type 1 can be implemented later - - append_dedup # SCD Type 1 & 2 - AirbyteArchive: - type: string - format: binary - description: Tarball Archive (.tar.gz) of Airbyte Configuration and Database - ImportRead: - type: object - required: - - status - properties: - status: - type: string - enum: - - succeeded - - failed - reason: - type: string - ResourceId: - type: string - format: uuid - UploadRead: - type: object - required: - - status - properties: - status: - type: string - enum: - - succeeded - - failed - resourceId: - $ref: "#/components/schemas/ResourceId" - ImportRequestBody: - type: object - required: - - resourceId - - workspaceId - properties: - resourceId: - $ref: "#/components/schemas/ResourceId" - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - AttemptNumber: - type: integer - format: int32 - WorkflowId: - type: string - SetWorkflowInAttemptRequestBody: - type: object - required: - - jobId - - attemptNumber - - workflowId - properties: - jobId: - $ref: "#/components/schemas/JobId" - attemptNumber: - $ref: "#/components/schemas/AttemptNumber" - workflowId: - $ref: "#/components/schemas/WorkflowId" - processingTaskQueue: - type: string - default: "" - SaveStatsRequestBody: - type: object - required: - - jobId - - attemptNumber - - stats - properties: - jobId: - $ref: "#/components/schemas/JobId" - attemptNumber: - $ref: "#/components/schemas/AttemptNumber" - stats: - $ref: "#/components/schemas/AttemptStats" - streamStats: - type: array - items: - $ref: "#/components/schemas/AttemptStreamStats" - AttemptSyncConfig: - type: object - required: - - sourceConfiguration - - destinationConfiguration - properties: - sourceConfiguration: - $ref: "#/components/schemas/SourceConfiguration" - destinationConfiguration: - $ref: "#/components/schemas/DestinationConfiguration" - state: - $ref: "#/components/schemas/ConnectionState" - SaveAttemptSyncConfigRequestBody: - type: object - required: - - jobId - - attemptNumber - - syncConfig - properties: - jobId: - $ref: "#/components/schemas/JobId" - attemptNumber: - $ref: "#/components/schemas/AttemptNumber" - syncConfig: - $ref: "#/components/schemas/AttemptSyncConfig" - InternalOperationResult: - type: object - required: - - succeeded - properties: - succeeded: - type: boolean - DiscoverCatalogResult: - type: object - required: - - catalogId - properties: - catalogId: - type: string - format: uuid - AttemptNormalizationStatusReadList: - type: object - properties: - attemptNormalizationStatuses: - type: array - items: - $ref: "#/components/schemas/AttemptNormalizationStatusRead" - AttemptNormalizationStatusRead: - type: object - properties: - attemptNumber: - $ref: "#/components/schemas/AttemptNumber" - hasRecordsCommitted: - type: boolean - recordsCommitted: - type: integer - format: int64 - hasNormalizationFailed: - type: boolean - StreamStatusId: - type: string - format: uuid - StreamStatusRunState: - type: string - description: > - Values: - * `PENDING` - The stream operation has been selected to run - * `RUNNING` - The stream operation is running - * `COMPLETE` - The stream operation ran successfully to completion - * `INCOMPLETE` - The stream operation has terminated in an incomplete state. - See StreamStatusIncompleteRunCause for more details. - enum: - - PENDING - - RUNNING - - COMPLETE - - INCOMPLETE - StreamStatusIncompleteRunCause: - type: string - description: > - Values: - * `FAILED` - A failure has occurred - * `CANCELED` - The run has been canceled - enum: - - FAILED - - CANCELED - StreamStatusJobType: - type: string - enum: - - SYNC - - RESET - StreamStatusListRequestBody: - type: object - required: - - pagination - - workspaceId - properties: - attemptNumber: - $ref: "#/components/schemas/AttemptNumber" - connectionId: - $ref: "#/components/schemas/ConnectionId" - jobId: - $ref: "#/components/schemas/JobId" - jobType: - $ref: "#/components/schemas/StreamStatusJobType" - pagination: - $ref: "#/components/schemas/Pagination" - streamName: - type: string - streamNamespace: - type: string - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - StreamStatusCreateRequestBody: - type: object - required: - - attemptNumber - - connectionId - - jobId - - jobType - - runState - - streamName - - transitionedAt - - workspaceId - properties: - attemptNumber: - $ref: "#/components/schemas/AttemptNumber" - connectionId: - $ref: "#/components/schemas/ConnectionId" - jobId: - $ref: "#/components/schemas/JobId" - incompleteRunCause: - $ref: "#/components/schemas/StreamStatusIncompleteRunCause" - jobType: - $ref: "#/components/schemas/StreamStatusJobType" - runState: - $ref: "#/components/schemas/StreamStatusRunState" - streamName: - type: string - streamNamespace: - type: string - transitionedAt: - type: integer - format: int64 - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - StreamStatusUpdateRequestBody: - type: object - allOf: - - $ref: "#/components/schemas/StreamStatusCreateRequestBody" - required: - - id - properties: - id: - $ref: "#/components/schemas/StreamStatusId" - StreamStatusRead: - type: object - required: - - attemptNumber - - connectionId - - id - - jobId - - jobType - - runState - - streamName - - streamNamespace - - transitionedAt - - workspaceId - properties: - attemptNumber: - $ref: "#/components/schemas/AttemptNumber" - connectionId: - $ref: "#/components/schemas/ConnectionId" - id: - $ref: "#/components/schemas/StreamStatusId" - jobId: - $ref: "#/components/schemas/JobId" - incompleteRunCause: - $ref: "#/components/schemas/StreamStatusIncompleteRunCause" - jobType: - $ref: "#/components/schemas/StreamStatusJobType" - runState: - $ref: "#/components/schemas/StreamStatusRunState" - streamName: - type: string - streamNamespace: - type: string - transitionedAt: - type: integer - format: int64 - workspaceId: - $ref: "#/components/schemas/WorkspaceId" - StreamStatusReadList: - type: object - properties: - streamStatuses: - type: array - items: - $ref: "#/components/schemas/StreamStatusRead" - InvalidInputProperty: - type: object - required: - - propertyPath - properties: - propertyPath: - type: string - invalidValue: - type: string - message: - type: string - NotFoundKnownExceptionInfo: - type: object - required: - - message - properties: - id: - type: string - message: - type: string - exceptionClassName: - type: string - exceptionStack: - type: array - items: - type: string - rootCauseExceptionClassName: - type: string - rootCauseExceptionStack: - type: array - items: - type: string - KnownExceptionInfo: - type: object - required: - - message - properties: - message: - type: string - exceptionClassName: - type: string - exceptionStack: - type: array - items: - type: string - rootCauseExceptionClassName: - type: string - rootCauseExceptionStack: - type: array - items: - type: string - InvalidInputExceptionInfo: - type: object - required: - - message - - validationErrors - properties: - message: - type: string - exceptionClassName: - type: string - exceptionStack: - type: array - items: - type: string - validationErrors: - type: array - items: - $ref: "#/components/schemas/InvalidInputProperty" - - responses: - NotFoundResponse: - description: Object with given id was not found. - content: - application/json: - schema: - $ref: "#/components/schemas/NotFoundKnownExceptionInfo" - InvalidInputResponse: - description: Input failed validation - content: - application/json: - schema: - $ref: "#/components/schemas/InvalidInputExceptionInfo" - ExceptionResponse: - description: Exception occurred; see message for details. - content: - application/json: - schema: - $ref: "#/components/schemas/KnownExceptionInfo" -security: - - {} diff --git a/docs/reference/api/generated-api-html/index.html b/docs/reference/api/generated-api-html/index.html deleted file mode 100644 index 5dbff2a0eeae..000000000000 --- a/docs/reference/api/generated-api-html/index.html +++ /dev/null @@ -1,15361 +0,0 @@ - - - - Airbyte Configuration API - - - -

Airbyte Configuration API

-

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}/{METHOD_FAMILY}/{METHOD_NAME} 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=="
    • -
-
-
More information: https://openapi-generator.tech
-
Contact Info: contact@airbyte.io
-
Version: 1.0.0
-
BasePath:/api
-
MIT
-
https://opensource.org/licenses/MIT
-

Access

-
    -
  1. HTTP Basic Authentication
    2. -
- -

Methods

- [ Jump to Models ] - -

Table of Contents

-
-

Attempt

- -

Connection

- -

ConnectorBuilderProject

- -

DeclarativeSourceDefinitions

- -

Destination

- -

DestinationDefinition

- -

DestinationDefinitionSpecification

- -

DestinationOauth

- -

Health

- -

Internal

- -

Jobs

- -

Logs

- -

Notifications

- -

Openapi

- -

Operation

- -

Scheduler

- -

Source

- -

SourceDefinition

- -

SourceDefinitionSpecification

- -

SourceOauth

- -

State

- -

StreamStatuses

- -

Streams

- -

WebBackend

- -

Workspace

- - -

Attempt

-
-
- Up - 
post /v1/attempt/save_stats
-
For worker to set sync stats of a running attempt. (saveStats)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SaveStatsRequestBody SaveStatsRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- InternalOperationResult - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "succeeded" : true
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful Operation - InternalOperationResult -
-
-
-
- Up - 
post /v1/attempt/save_sync_config
-
For worker to save the AttemptSyncConfig for an attempt. (saveSyncConfig)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SaveAttemptSyncConfigRequestBody SaveAttemptSyncConfigRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- InternalOperationResult - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "succeeded" : true
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful Operation - InternalOperationResult -
-
-
-
- Up - 
post /v1/attempt/set_workflow_in_attempt
-
For worker to register the workflow id in attempt. (setWorkflowInAttempt)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SetWorkflowInAttemptRequestBody SetWorkflowInAttemptRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- InternalOperationResult - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "succeeded" : true
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful Operation - InternalOperationResult -
-
-

Connection

-
-
- Up - 
post /v1/connections/create
-
Create a connection between a source and a destination (createConnection)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectionCreate ConnectionCreate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- ConnectionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "prefix" : "prefix",
-  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "resourceRequirements" : {
-    "cpu_limit" : "cpu_limit",
-    "memory_request" : "memory_request",
-    "memory_limit" : "memory_limit",
-    "cpu_request" : "cpu_request"
-  },
-  "schedule" : {
-    "units" : 0,
-    "timeUnit" : "minutes"
-  },
-  "breakingChange" : true,
-  "notifySchemaChanges" : true,
-  "notifySchemaChangesByEmail" : true,
-  "name" : "name",
-  "syncCatalog" : {
-    "streams" : [ {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "suggested" : true,
-        "fieldSelectionEnabled" : true,
-        "selectedFields" : [ {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        }, {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        } ],
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-      }
-    }, {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "suggested" : true,
-        "fieldSelectionEnabled" : true,
-        "selectedFields" : [ {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        }, {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        } ],
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-      }
-    } ]
-  },
-  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "namespaceFormat" : "${SOURCE_NAMESPACE}",
-  "operationIds" : [ null, null ],
-  "scheduleData" : {
-    "cron" : {
-      "cronExpression" : "cronExpression",
-      "cronTimeZone" : "cronTimeZone"
-    },
-    "basicSchedule" : {
-      "units" : 6,
-      "timeUnit" : "minutes"
-    }
-  },
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - ConnectionRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/connections/delete
-
Delete a connection (deleteConnection)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectionIdRequestBody ConnectionIdRequestBody (required)
- -
Body Parameter —
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

204

- The resource was deleted successfully. - -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/connections/get
-
Get a connection (getConnection)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectionIdRequestBody ConnectionIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- ConnectionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "prefix" : "prefix",
-  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "resourceRequirements" : {
-    "cpu_limit" : "cpu_limit",
-    "memory_request" : "memory_request",
-    "memory_limit" : "memory_limit",
-    "cpu_request" : "cpu_request"
-  },
-  "schedule" : {
-    "units" : 0,
-    "timeUnit" : "minutes"
-  },
-  "breakingChange" : true,
-  "notifySchemaChanges" : true,
-  "notifySchemaChangesByEmail" : true,
-  "name" : "name",
-  "syncCatalog" : {
-    "streams" : [ {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "suggested" : true,
-        "fieldSelectionEnabled" : true,
-        "selectedFields" : [ {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        }, {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        } ],
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-      }
-    }, {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "suggested" : true,
-        "fieldSelectionEnabled" : true,
-        "selectedFields" : [ {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        }, {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        } ],
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-      }
-    } ]
-  },
-  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "namespaceFormat" : "${SOURCE_NAMESPACE}",
-  "operationIds" : [ null, null ],
-  "scheduleData" : {
-    "cron" : {
-      "cronExpression" : "cronExpression",
-      "cronTimeZone" : "cronTimeZone"
-    },
-    "basicSchedule" : {
-      "units" : 6,
-      "timeUnit" : "minutes"
-    }
-  },
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - ConnectionRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/connections/list_all
-
Returns all connections for a workspace, including deleted connections. (listAllConnectionsForWorkspace)
-
List connections for workspace, including deleted connections.
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- ConnectionReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "connections" : [ {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "prefix" : "prefix",
-    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "resourceRequirements" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
-    },
-    "schedule" : {
-      "units" : 0,
-      "timeUnit" : "minutes"
-    },
-    "breakingChange" : true,
-    "notifySchemaChanges" : true,
-    "notifySchemaChangesByEmail" : true,
-    "name" : "name",
-    "syncCatalog" : {
-      "streams" : [ {
-        "stream" : {
-          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-          "supportedSyncModes" : [ null, null ],
-          "sourceDefinedCursor" : true,
-          "name" : "name",
-          "namespace" : "namespace",
-          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-        },
-        "config" : {
-          "aliasName" : "aliasName",
-          "suggested" : true,
-          "fieldSelectionEnabled" : true,
-          "selectedFields" : [ {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          }, {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          } ],
-          "cursorField" : [ "cursorField", "cursorField" ],
-          "selected" : true,
-          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-        }
-      }, {
-        "stream" : {
-          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-          "supportedSyncModes" : [ null, null ],
-          "sourceDefinedCursor" : true,
-          "name" : "name",
-          "namespace" : "namespace",
-          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-        },
-        "config" : {
-          "aliasName" : "aliasName",
-          "suggested" : true,
-          "fieldSelectionEnabled" : true,
-          "selectedFields" : [ {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          }, {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          } ],
-          "cursorField" : [ "cursorField", "cursorField" ],
-          "selected" : true,
-          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-        }
-      } ]
-    },
-    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "namespaceFormat" : "${SOURCE_NAMESPACE}",
-    "operationIds" : [ null, null ],
-    "scheduleData" : {
-      "cron" : {
-        "cronExpression" : "cronExpression",
-        "cronTimeZone" : "cronTimeZone"
-      },
-      "basicSchedule" : {
-        "units" : 6,
-        "timeUnit" : "minutes"
-      }
-    },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "prefix" : "prefix",
-    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "resourceRequirements" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
-    },
-    "schedule" : {
-      "units" : 0,
-      "timeUnit" : "minutes"
-    },
-    "breakingChange" : true,
-    "notifySchemaChanges" : true,
-    "notifySchemaChangesByEmail" : true,
-    "name" : "name",
-    "syncCatalog" : {
-      "streams" : [ {
-        "stream" : {
-          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-          "supportedSyncModes" : [ null, null ],
-          "sourceDefinedCursor" : true,
-          "name" : "name",
-          "namespace" : "namespace",
-          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-        },
-        "config" : {
-          "aliasName" : "aliasName",
-          "suggested" : true,
-          "fieldSelectionEnabled" : true,
-          "selectedFields" : [ {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          }, {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          } ],
-          "cursorField" : [ "cursorField", "cursorField" ],
-          "selected" : true,
-          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-        }
-      }, {
-        "stream" : {
-          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-          "supportedSyncModes" : [ null, null ],
-          "sourceDefinedCursor" : true,
-          "name" : "name",
-          "namespace" : "namespace",
-          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-        },
-        "config" : {
-          "aliasName" : "aliasName",
-          "suggested" : true,
-          "fieldSelectionEnabled" : true,
-          "selectedFields" : [ {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          }, {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          } ],
-          "cursorField" : [ "cursorField", "cursorField" ],
-          "selected" : true,
-          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-        }
-      } ]
-    },
-    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "namespaceFormat" : "${SOURCE_NAMESPACE}",
-    "operationIds" : [ null, null ],
-    "scheduleData" : {
-      "cron" : {
-        "cronExpression" : "cronExpression",
-        "cronTimeZone" : "cronTimeZone"
-      },
-      "basicSchedule" : {
-        "units" : 6,
-        "timeUnit" : "minutes"
-      }
-    },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - ConnectionReadList -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/connections/list_by_actor_definition
-
List all connections that use the provided actor definition (listConnectionsByActorDefinition)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ActorDefinitionRequestBody ActorDefinitionRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- ConnectionReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "connections" : [ {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "prefix" : "prefix",
-    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "resourceRequirements" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
-    },
-    "schedule" : {
-      "units" : 0,
-      "timeUnit" : "minutes"
-    },
-    "breakingChange" : true,
-    "notifySchemaChanges" : true,
-    "notifySchemaChangesByEmail" : true,
-    "name" : "name",
-    "syncCatalog" : {
-      "streams" : [ {
-        "stream" : {
-          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-          "supportedSyncModes" : [ null, null ],
-          "sourceDefinedCursor" : true,
-          "name" : "name",
-          "namespace" : "namespace",
-          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-        },
-        "config" : {
-          "aliasName" : "aliasName",
-          "suggested" : true,
-          "fieldSelectionEnabled" : true,
-          "selectedFields" : [ {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          }, {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          } ],
-          "cursorField" : [ "cursorField", "cursorField" ],
-          "selected" : true,
-          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-        }
-      }, {
-        "stream" : {
-          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-          "supportedSyncModes" : [ null, null ],
-          "sourceDefinedCursor" : true,
-          "name" : "name",
-          "namespace" : "namespace",
-          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-        },
-        "config" : {
-          "aliasName" : "aliasName",
-          "suggested" : true,
-          "fieldSelectionEnabled" : true,
-          "selectedFields" : [ {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          }, {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          } ],
-          "cursorField" : [ "cursorField", "cursorField" ],
-          "selected" : true,
-          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-        }
-      } ]
-    },
-    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "namespaceFormat" : "${SOURCE_NAMESPACE}",
-    "operationIds" : [ null, null ],
-    "scheduleData" : {
-      "cron" : {
-        "cronExpression" : "cronExpression",
-        "cronTimeZone" : "cronTimeZone"
-      },
-      "basicSchedule" : {
-        "units" : 6,
-        "timeUnit" : "minutes"
-      }
-    },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "prefix" : "prefix",
-    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "resourceRequirements" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
-    },
-    "schedule" : {
-      "units" : 0,
-      "timeUnit" : "minutes"
-    },
-    "breakingChange" : true,
-    "notifySchemaChanges" : true,
-    "notifySchemaChangesByEmail" : true,
-    "name" : "name",
-    "syncCatalog" : {
-      "streams" : [ {
-        "stream" : {
-          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-          "supportedSyncModes" : [ null, null ],
-          "sourceDefinedCursor" : true,
-          "name" : "name",
-          "namespace" : "namespace",
-          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-        },
-        "config" : {
-          "aliasName" : "aliasName",
-          "suggested" : true,
-          "fieldSelectionEnabled" : true,
-          "selectedFields" : [ {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          }, {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          } ],
-          "cursorField" : [ "cursorField", "cursorField" ],
-          "selected" : true,
-          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-        }
-      }, {
-        "stream" : {
-          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-          "supportedSyncModes" : [ null, null ],
-          "sourceDefinedCursor" : true,
-          "name" : "name",
-          "namespace" : "namespace",
-          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-        },
-        "config" : {
-          "aliasName" : "aliasName",
-          "suggested" : true,
-          "fieldSelectionEnabled" : true,
-          "selectedFields" : [ {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          }, {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          } ],
-          "cursorField" : [ "cursorField", "cursorField" ],
-          "selected" : true,
-          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-        }
-      } ]
-    },
-    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "namespaceFormat" : "${SOURCE_NAMESPACE}",
-    "operationIds" : [ null, null ],
-    "scheduleData" : {
-      "cron" : {
-        "cronExpression" : "cronExpression",
-        "cronTimeZone" : "cronTimeZone"
-      },
-      "basicSchedule" : {
-        "units" : 6,
-        "timeUnit" : "minutes"
-      }
-    },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - ConnectionReadList -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/connections/list
-
Returns all connections for a workspace. (listConnectionsForWorkspace)
-
List connections for workspace. Does not return deleted connections.
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- ConnectionReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "connections" : [ {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "prefix" : "prefix",
-    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "resourceRequirements" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
-    },
-    "schedule" : {
-      "units" : 0,
-      "timeUnit" : "minutes"
-    },
-    "breakingChange" : true,
-    "notifySchemaChanges" : true,
-    "notifySchemaChangesByEmail" : true,
-    "name" : "name",
-    "syncCatalog" : {
-      "streams" : [ {
-        "stream" : {
-          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-          "supportedSyncModes" : [ null, null ],
-          "sourceDefinedCursor" : true,
-          "name" : "name",
-          "namespace" : "namespace",
-          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-        },
-        "config" : {
-          "aliasName" : "aliasName",
-          "suggested" : true,
-          "fieldSelectionEnabled" : true,
-          "selectedFields" : [ {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          }, {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          } ],
-          "cursorField" : [ "cursorField", "cursorField" ],
-          "selected" : true,
-          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-        }
-      }, {
-        "stream" : {
-          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-          "supportedSyncModes" : [ null, null ],
-          "sourceDefinedCursor" : true,
-          "name" : "name",
-          "namespace" : "namespace",
-          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-        },
-        "config" : {
-          "aliasName" : "aliasName",
-          "suggested" : true,
-          "fieldSelectionEnabled" : true,
-          "selectedFields" : [ {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          }, {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          } ],
-          "cursorField" : [ "cursorField", "cursorField" ],
-          "selected" : true,
-          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-        }
-      } ]
-    },
-    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "namespaceFormat" : "${SOURCE_NAMESPACE}",
-    "operationIds" : [ null, null ],
-    "scheduleData" : {
-      "cron" : {
-        "cronExpression" : "cronExpression",
-        "cronTimeZone" : "cronTimeZone"
-      },
-      "basicSchedule" : {
-        "units" : 6,
-        "timeUnit" : "minutes"
-      }
-    },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "prefix" : "prefix",
-    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "resourceRequirements" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
-    },
-    "schedule" : {
-      "units" : 0,
-      "timeUnit" : "minutes"
-    },
-    "breakingChange" : true,
-    "notifySchemaChanges" : true,
-    "notifySchemaChangesByEmail" : true,
-    "name" : "name",
-    "syncCatalog" : {
-      "streams" : [ {
-        "stream" : {
-          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-          "supportedSyncModes" : [ null, null ],
-          "sourceDefinedCursor" : true,
-          "name" : "name",
-          "namespace" : "namespace",
-          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-        },
-        "config" : {
-          "aliasName" : "aliasName",
-          "suggested" : true,
-          "fieldSelectionEnabled" : true,
-          "selectedFields" : [ {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          }, {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          } ],
-          "cursorField" : [ "cursorField", "cursorField" ],
-          "selected" : true,
-          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-        }
-      }, {
-        "stream" : {
-          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-          "supportedSyncModes" : [ null, null ],
-          "sourceDefinedCursor" : true,
-          "name" : "name",
-          "namespace" : "namespace",
-          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-        },
-        "config" : {
-          "aliasName" : "aliasName",
-          "suggested" : true,
-          "fieldSelectionEnabled" : true,
-          "selectedFields" : [ {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          }, {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          } ],
-          "cursorField" : [ "cursorField", "cursorField" ],
-          "selected" : true,
-          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-        }
-      } ]
-    },
-    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "namespaceFormat" : "${SOURCE_NAMESPACE}",
-    "operationIds" : [ null, null ],
-    "scheduleData" : {
-      "cron" : {
-        "cronExpression" : "cronExpression",
-        "cronTimeZone" : "cronTimeZone"
-      },
-      "basicSchedule" : {
-        "units" : 6,
-        "timeUnit" : "minutes"
-      }
-    },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - ConnectionReadList -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
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. (resetConnection)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectionIdRequestBody ConnectionIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- JobInfoRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "job" : {
-    "createdAt" : 6,
-    "enabledStreams" : [ {
-      "name" : "name",
-      "namespace" : "namespace"
-    }, {
-      "name" : "name",
-      "namespace" : "namespace"
-    } ],
-    "configId" : "configId",
-    "startedAt" : 5,
-    "id" : 0,
-    "resetConfig" : {
-      "streamsToReset" : [ {
-        "name" : "name",
-        "namespace" : "namespace"
-      }, {
-        "name" : "name",
-        "namespace" : "namespace"
-      } ]
-    },
-    "updatedAt" : 1
-  },
-  "attempts" : [ {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
-  }, {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - JobInfoRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
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. (resetConnectionStream)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectionStreamRequestBody ConnectionStreamRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- JobInfoRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "job" : {
-    "createdAt" : 6,
-    "enabledStreams" : [ {
-      "name" : "name",
-      "namespace" : "namespace"
-    }, {
-      "name" : "name",
-      "namespace" : "namespace"
-    } ],
-    "configId" : "configId",
-    "startedAt" : 5,
-    "id" : 0,
-    "resetConfig" : {
-      "streamsToReset" : [ {
-        "name" : "name",
-        "namespace" : "namespace"
-      }, {
-        "name" : "name",
-        "namespace" : "namespace"
-      } ]
-    },
-    "updatedAt" : 1
-  },
-  "attempts" : [ {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
-  }, {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - JobInfoRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/connections/search
-
Search connections (searchConnections)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectionSearch ConnectionSearch (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- ConnectionReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "connections" : [ {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "prefix" : "prefix",
-    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "resourceRequirements" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
-    },
-    "schedule" : {
-      "units" : 0,
-      "timeUnit" : "minutes"
-    },
-    "breakingChange" : true,
-    "notifySchemaChanges" : true,
-    "notifySchemaChangesByEmail" : true,
-    "name" : "name",
-    "syncCatalog" : {
-      "streams" : [ {
-        "stream" : {
-          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-          "supportedSyncModes" : [ null, null ],
-          "sourceDefinedCursor" : true,
-          "name" : "name",
-          "namespace" : "namespace",
-          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-        },
-        "config" : {
-          "aliasName" : "aliasName",
-          "suggested" : true,
-          "fieldSelectionEnabled" : true,
-          "selectedFields" : [ {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          }, {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          } ],
-          "cursorField" : [ "cursorField", "cursorField" ],
-          "selected" : true,
-          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-        }
-      }, {
-        "stream" : {
-          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-          "supportedSyncModes" : [ null, null ],
-          "sourceDefinedCursor" : true,
-          "name" : "name",
-          "namespace" : "namespace",
-          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-        },
-        "config" : {
-          "aliasName" : "aliasName",
-          "suggested" : true,
-          "fieldSelectionEnabled" : true,
-          "selectedFields" : [ {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          }, {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          } ],
-          "cursorField" : [ "cursorField", "cursorField" ],
-          "selected" : true,
-          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-        }
-      } ]
-    },
-    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "namespaceFormat" : "${SOURCE_NAMESPACE}",
-    "operationIds" : [ null, null ],
-    "scheduleData" : {
-      "cron" : {
-        "cronExpression" : "cronExpression",
-        "cronTimeZone" : "cronTimeZone"
-      },
-      "basicSchedule" : {
-        "units" : 6,
-        "timeUnit" : "minutes"
-      }
-    },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "prefix" : "prefix",
-    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "resourceRequirements" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
-    },
-    "schedule" : {
-      "units" : 0,
-      "timeUnit" : "minutes"
-    },
-    "breakingChange" : true,
-    "notifySchemaChanges" : true,
-    "notifySchemaChangesByEmail" : true,
-    "name" : "name",
-    "syncCatalog" : {
-      "streams" : [ {
-        "stream" : {
-          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-          "supportedSyncModes" : [ null, null ],
-          "sourceDefinedCursor" : true,
-          "name" : "name",
-          "namespace" : "namespace",
-          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-        },
-        "config" : {
-          "aliasName" : "aliasName",
-          "suggested" : true,
-          "fieldSelectionEnabled" : true,
-          "selectedFields" : [ {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          }, {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          } ],
-          "cursorField" : [ "cursorField", "cursorField" ],
-          "selected" : true,
-          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-        }
-      }, {
-        "stream" : {
-          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-          "supportedSyncModes" : [ null, null ],
-          "sourceDefinedCursor" : true,
-          "name" : "name",
-          "namespace" : "namespace",
-          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-        },
-        "config" : {
-          "aliasName" : "aliasName",
-          "suggested" : true,
-          "fieldSelectionEnabled" : true,
-          "selectedFields" : [ {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          }, {
-            "fieldPath" : [ "fieldPath", "fieldPath" ]
-          } ],
-          "cursorField" : [ "cursorField", "cursorField" ],
-          "selected" : true,
-          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-        }
-      } ]
-    },
-    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "namespaceFormat" : "${SOURCE_NAMESPACE}",
-    "operationIds" : [ null, null ],
-    "scheduleData" : {
-      "cron" : {
-        "cronExpression" : "cronExpression",
-        "cronTimeZone" : "cronTimeZone"
-      },
-      "basicSchedule" : {
-        "units" : 6,
-        "timeUnit" : "minutes"
-      }
-    },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - ConnectionReadList -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/connections/sync
-
Trigger a manual sync of the connection (syncConnection)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectionIdRequestBody ConnectionIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- JobInfoRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "job" : {
-    "createdAt" : 6,
-    "enabledStreams" : [ {
-      "name" : "name",
-      "namespace" : "namespace"
-    }, {
-      "name" : "name",
-      "namespace" : "namespace"
-    } ],
-    "configId" : "configId",
-    "startedAt" : 5,
-    "id" : 0,
-    "resetConfig" : {
-      "streamsToReset" : [ {
-        "name" : "name",
-        "namespace" : "namespace"
-      }, {
-        "name" : "name",
-        "namespace" : "namespace"
-      } ]
-    },
-    "updatedAt" : 1
-  },
-  "attempts" : [ {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
-  }, {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - JobInfoRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/connections/update
-
Update a connection (updateConnection)
-
Apply a patch-style update to a connection. Only fields present on the update request body will be updated. -Note that if a catalog is present in the request body, the connection's entire catalog will be replaced -with the catalog from the request. This means that to modify a single stream, the entire new catalog -containing the updated stream needs to be sent.
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectionUpdate ConnectionUpdate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- ConnectionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "prefix" : "prefix",
-  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "resourceRequirements" : {
-    "cpu_limit" : "cpu_limit",
-    "memory_request" : "memory_request",
-    "memory_limit" : "memory_limit",
-    "cpu_request" : "cpu_request"
-  },
-  "schedule" : {
-    "units" : 0,
-    "timeUnit" : "minutes"
-  },
-  "breakingChange" : true,
-  "notifySchemaChanges" : true,
-  "notifySchemaChangesByEmail" : true,
-  "name" : "name",
-  "syncCatalog" : {
-    "streams" : [ {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "suggested" : true,
-        "fieldSelectionEnabled" : true,
-        "selectedFields" : [ {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        }, {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        } ],
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-      }
-    }, {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "suggested" : true,
-        "fieldSelectionEnabled" : true,
-        "selectedFields" : [ {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        }, {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        } ],
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-      }
-    } ]
-  },
-  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "namespaceFormat" : "${SOURCE_NAMESPACE}",
-  "operationIds" : [ null, null ],
-  "scheduleData" : {
-    "cron" : {
-      "cronExpression" : "cronExpression",
-      "cronTimeZone" : "cronTimeZone"
-    },
-    "basicSchedule" : {
-      "units" : 6,
-      "timeUnit" : "minutes"
-    }
-  },
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - ConnectionRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-

ConnectorBuilderProject

-
-
- Up - 
post /v1/connector_builder_projects/create
-
Create new connector builder project (createConnectorBuilderProject)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectorBuilderProjectWithWorkspaceId ConnectorBuilderProjectWithWorkspaceId (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- ConnectorBuilderProjectIdWithWorkspaceId - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "builderProjectId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "version" : 0,
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

201

- Successful operation - ConnectorBuilderProjectIdWithWorkspaceId -
-
-
-
- Up - 
post /v1/connector_builder_projects/delete
-
Deletes connector builder project (deleteConnectorBuilderProject)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectorBuilderProjectIdWithWorkspaceId ConnectorBuilderProjectIdWithWorkspaceId (required)
- -
Body Parameter —
- -
- - - - - - - - - -

Responses

-

204

- Successful operation - -
-
-
-
- Up - 
post /v1/connector_builder_projects/get_with_manifest
-
Get a connector builder project with draft manifest (getConnectorBuilderProject)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectorBuilderProjectIdWithWorkspaceId ConnectorBuilderProjectIdWithWorkspaceId (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- ConnectorBuilderProjectRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "declarativeManifest" : {
-    "manifest" : "{}",
-    "isDraft" : true,
-    "description" : "description",
-    "version" : 0
-  },
-  "builderProject" : {
-    "hasDraft" : true,
-    "activeDeclarativeManifestVersion" : 0,
-    "builderProjectId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "name" : "name",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - ConnectorBuilderProjectRead -
-
-
-
- Up - 
post /v1/connector_builder_projects/list
-
List connector builder projects for workspace (listConnectorBuilderProjects)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- ConnectorBuilderProjectReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "projects" : [ {
-    "hasDraft" : true,
-    "activeDeclarativeManifestVersion" : 0,
-    "builderProjectId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "name" : "name",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "hasDraft" : true,
-    "activeDeclarativeManifestVersion" : 0,
-    "builderProjectId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "name" : "name",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - ConnectorBuilderProjectReadList -
-
-
-
- Up - 
post /v1/connector_builder_projects/publish
-
Publish a connector to the workspace (publishConnectorBuilderProject)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectorBuilderPublishRequestBody ConnectorBuilderPublishRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- SourceDefinitionIdBody - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceDefinitionIdBody -
-
-
-
- Up - 
post /v1/connector_builder_projects/update
-
Update connector builder project (updateConnectorBuilderProject)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ExistingConnectorBuilderProjectWithWorkspaceId ExistingConnectorBuilderProjectWithWorkspaceId (required)
- -
Body Parameter —
- -
- - - - - - - - - -

Responses

-

204

- Successful operation - -
-
-

DeclarativeSourceDefinitions

-
-
- Up - 
post /v1/declarative_source_definitions/create_manifest
-
Create a declarative manifest to be used by the specified source definition (createDeclarativeSourceDefinitionManifest)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DeclarativeSourceDefinitionCreateManifestRequestBody DeclarativeSourceDefinitionCreateManifestRequestBody (required)
- -
Body Parameter —
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

201

- Successful operation - -

400

- Definition is not declarative source - -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

409

- Version already exists for definition id - -
-
-
-
- Up - 
post /v1/declarative_source_definitions/list_manifests
-
List all available declarative manifest versions of a declarative source definition (listDeclarativeManifests)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ListDeclarativeManifestsRequestBody ListDeclarativeManifestsRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- DeclarativeManifestsReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "manifestVersions" : [ {
-    "description" : "description",
-    "isActive" : true,
-    "version" : 0
-  }, {
-    "description" : "description",
-    "isActive" : true,
-    "version" : 0
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - DeclarativeManifestsReadList -

400

- Definition is not declarative source - -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -
-
-
-
- Up - 
post /v1/declarative_source_definitions/update_active_manifest
-
Update the declarative manifest version for a source (updateDeclarativeManifestVersion)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
UpdateActiveManifestRequestBody UpdateActiveManifestRequestBody (required)
- -
Body Parameter —
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

204

- Successful operation - -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -
-
-

Destination

-
-
- Up - 
post /v1/destinations/check_connection
-
Check connection to the destination (checkConnectionToDestination)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationIdRequestBody DestinationIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- CheckConnectionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "message" : "message",
-  "jobInfo" : {
-    "createdAt" : 0,
-    "connectorConfigurationUpdated" : false,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "failureReason" : {
-      "retryable" : true,
-      "stacktrace" : "stacktrace",
-      "internalMessage" : "internalMessage",
-      "externalMessage" : "externalMessage",
-      "timestamp" : 1
-    },
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    },
-    "succeeded" : true
-  },
-  "status" : "succeeded"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - CheckConnectionRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destinations/check_connection_for_update
-
Check connection for a proposed update to a destination (checkConnectionToDestinationForUpdate)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationUpdate DestinationUpdate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- CheckConnectionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "message" : "message",
-  "jobInfo" : {
-    "createdAt" : 0,
-    "connectorConfigurationUpdated" : false,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "failureReason" : {
-      "retryable" : true,
-      "stacktrace" : "stacktrace",
-      "internalMessage" : "internalMessage",
-      "externalMessage" : "externalMessage",
-      "timestamp" : 1
-    },
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    },
-    "succeeded" : true
-  },
-  "status" : "succeeded"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - CheckConnectionRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destinations/clone
-
Clone destination (cloneDestination)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationCloneRequestBody DestinationCloneRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- DestinationRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "connectionConfiguration" : {
-    "user" : "charles"
-  },
-  "destinationName" : "destinationName",
-  "name" : "name",
-  "icon" : "icon",
-  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - DestinationRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destinations/create
-
Create a destination (createDestination)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationCreate DestinationCreate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- DestinationRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "connectionConfiguration" : {
-    "user" : "charles"
-  },
-  "destinationName" : "destinationName",
-  "name" : "name",
-  "icon" : "icon",
-  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - DestinationRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destinations/delete
-
Delete the destination (deleteDestination)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationIdRequestBody DestinationIdRequestBody (required)
- -
Body Parameter —
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

204

- The resource was deleted successfully. - -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destinations/get
-
Get configured destination (getDestination)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationIdRequestBody DestinationIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- DestinationRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "connectionConfiguration" : {
-    "user" : "charles"
-  },
-  "destinationName" : "destinationName",
-  "name" : "name",
-  "icon" : "icon",
-  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - DestinationRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destinations/list
-
List configured destinations for a workspace (listDestinationsForWorkspace)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- DestinationReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "destinations" : [ {
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "destinationName" : "destinationName",
-    "name" : "name",
-    "icon" : "icon",
-    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "destinationName" : "destinationName",
-    "name" : "name",
-    "icon" : "icon",
-    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - DestinationReadList -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destinations/partial_update
-
Update a destination partially (partialUpdateDestination)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
PartialDestinationUpdate PartialDestinationUpdate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- DestinationRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "connectionConfiguration" : {
-    "user" : "charles"
-  },
-  "destinationName" : "destinationName",
-  "name" : "name",
-  "icon" : "icon",
-  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - DestinationRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destinations/search
-
Search destinations (searchDestinations)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationSearch DestinationSearch (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- DestinationReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "destinations" : [ {
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "destinationName" : "destinationName",
-    "name" : "name",
-    "icon" : "icon",
-    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "destinationName" : "destinationName",
-    "name" : "name",
-    "icon" : "icon",
-    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - DestinationReadList -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destinations/update
-
Update a destination (updateDestination)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationUpdate DestinationUpdate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- DestinationRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "connectionConfiguration" : {
-    "user" : "charles"
-  },
-  "destinationName" : "destinationName",
-  "name" : "name",
-  "icon" : "icon",
-  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - DestinationRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-

DestinationDefinition

-
-
- Up - 
post /v1/destination_definitions/create_custom
-
Creates a custom destinationDefinition for the given workspace (createCustomDestinationDefinition)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
CustomDestinationDefinitionCreate CustomDestinationDefinitionCreate (optional)
- -
Body Parameter —
- -
- - - - -

Return type

-
- DestinationDefinitionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "resourceRequirements" : {
-    "default" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
-    },
-    "jobSpecific" : [ {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    }, {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    } ]
-  },
-  "documentationUrl" : "https://openapi-generator.tech",
-  "dockerImageTag" : "dockerImageTag",
-  "releaseDate" : "2000-01-23",
-  "dockerRepository" : "dockerRepository",
-  "supportsDbt" : true,
-  "name" : "name",
-  "icon" : "icon",
-  "normalizationConfig" : {
-    "normalizationIntegrationType" : "normalizationIntegrationType",
-    "normalizationRepository" : "normalizationRepository",
-    "normalizationTag" : "normalizationTag",
-    "supported" : false
-  },
-  "protocolVersion" : "protocolVersion",
-  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - DestinationDefinitionRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destination_definitions/delete
-
Delete a destination definition (deleteDestinationDefinition)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationDefinitionIdRequestBody DestinationDefinitionIdRequestBody (required)
- -
Body Parameter —
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

204

- The resource was deleted successfully. - -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destination_definitions/get
-
Get destinationDefinition (getDestinationDefinition)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationDefinitionIdRequestBody DestinationDefinitionIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- DestinationDefinitionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "resourceRequirements" : {
-    "default" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
-    },
-    "jobSpecific" : [ {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    }, {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    } ]
-  },
-  "documentationUrl" : "https://openapi-generator.tech",
-  "dockerImageTag" : "dockerImageTag",
-  "releaseDate" : "2000-01-23",
-  "dockerRepository" : "dockerRepository",
-  "supportsDbt" : true,
-  "name" : "name",
-  "icon" : "icon",
-  "normalizationConfig" : {
-    "normalizationIntegrationType" : "normalizationIntegrationType",
-    "normalizationRepository" : "normalizationRepository",
-    "normalizationTag" : "normalizationTag",
-    "supported" : false
-  },
-  "protocolVersion" : "protocolVersion",
-  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - DestinationDefinitionRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destination_definitions/get_for_workspace
-
Get a destinationDefinition that is configured for the given workspace (getDestinationDefinitionForWorkspace)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationDefinitionIdWithWorkspaceId DestinationDefinitionIdWithWorkspaceId (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- DestinationDefinitionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "resourceRequirements" : {
-    "default" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
-    },
-    "jobSpecific" : [ {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    }, {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    } ]
-  },
-  "documentationUrl" : "https://openapi-generator.tech",
-  "dockerImageTag" : "dockerImageTag",
-  "releaseDate" : "2000-01-23",
-  "dockerRepository" : "dockerRepository",
-  "supportsDbt" : true,
-  "name" : "name",
-  "icon" : "icon",
-  "normalizationConfig" : {
-    "normalizationIntegrationType" : "normalizationIntegrationType",
-    "normalizationRepository" : "normalizationRepository",
-    "normalizationTag" : "normalizationTag",
-    "supported" : false
-  },
-  "protocolVersion" : "protocolVersion",
-  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - DestinationDefinitionRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destination_definitions/grant_definition
-
grant a private, non-custom destinationDefinition to a given workspace (grantDestinationDefinitionToWorkspace)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationDefinitionIdWithWorkspaceId DestinationDefinitionIdWithWorkspaceId (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- PrivateDestinationDefinitionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "destinationDefinition" : {
-    "resourceRequirements" : {
-      "default" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      },
-      "jobSpecific" : [ {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      }, {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      } ]
-    },
-    "documentationUrl" : "https://openapi-generator.tech",
-    "dockerImageTag" : "dockerImageTag",
-    "releaseDate" : "2000-01-23",
-    "dockerRepository" : "dockerRepository",
-    "supportsDbt" : true,
-    "name" : "name",
-    "icon" : "icon",
-    "normalizationConfig" : {
-      "normalizationIntegrationType" : "normalizationIntegrationType",
-      "normalizationRepository" : "normalizationRepository",
-      "normalizationTag" : "normalizationTag",
-      "supported" : false
-    },
-    "protocolVersion" : "protocolVersion",
-    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  },
-  "granted" : true
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - PrivateDestinationDefinitionRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destination_definitions/list
-
List all the destinationDefinitions the current Airbyte deployment is configured to use (listDestinationDefinitions)
-
- - - - - - - -

Return type

-
- DestinationDefinitionReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "destinationDefinitions" : [ {
-    "resourceRequirements" : {
-      "default" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      },
-      "jobSpecific" : [ {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      }, {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      } ]
-    },
-    "documentationUrl" : "https://openapi-generator.tech",
-    "dockerImageTag" : "dockerImageTag",
-    "releaseDate" : "2000-01-23",
-    "dockerRepository" : "dockerRepository",
-    "supportsDbt" : true,
-    "name" : "name",
-    "icon" : "icon",
-    "normalizationConfig" : {
-      "normalizationIntegrationType" : "normalizationIntegrationType",
-      "normalizationRepository" : "normalizationRepository",
-      "normalizationTag" : "normalizationTag",
-      "supported" : false
-    },
-    "protocolVersion" : "protocolVersion",
-    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "resourceRequirements" : {
-      "default" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      },
-      "jobSpecific" : [ {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      }, {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      } ]
-    },
-    "documentationUrl" : "https://openapi-generator.tech",
-    "dockerImageTag" : "dockerImageTag",
-    "releaseDate" : "2000-01-23",
-    "dockerRepository" : "dockerRepository",
-    "supportsDbt" : true,
-    "name" : "name",
-    "icon" : "icon",
-    "normalizationConfig" : {
-      "normalizationIntegrationType" : "normalizationIntegrationType",
-      "normalizationRepository" : "normalizationRepository",
-      "normalizationTag" : "normalizationTag",
-      "supported" : false
-    },
-    "protocolVersion" : "protocolVersion",
-    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - DestinationDefinitionReadList -
-
-
-
- Up - 
post /v1/destination_definitions/list_for_workspace
-
List all the destinationDefinitions the given workspace is configured to use (listDestinationDefinitionsForWorkspace)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WorkspaceIdRequestBody WorkspaceIdRequestBody (optional)
- -
Body Parameter —
- -
- - - - -

Return type

-
- DestinationDefinitionReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "destinationDefinitions" : [ {
-    "resourceRequirements" : {
-      "default" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      },
-      "jobSpecific" : [ {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      }, {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      } ]
-    },
-    "documentationUrl" : "https://openapi-generator.tech",
-    "dockerImageTag" : "dockerImageTag",
-    "releaseDate" : "2000-01-23",
-    "dockerRepository" : "dockerRepository",
-    "supportsDbt" : true,
-    "name" : "name",
-    "icon" : "icon",
-    "normalizationConfig" : {
-      "normalizationIntegrationType" : "normalizationIntegrationType",
-      "normalizationRepository" : "normalizationRepository",
-      "normalizationTag" : "normalizationTag",
-      "supported" : false
-    },
-    "protocolVersion" : "protocolVersion",
-    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "resourceRequirements" : {
-      "default" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      },
-      "jobSpecific" : [ {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      }, {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      } ]
-    },
-    "documentationUrl" : "https://openapi-generator.tech",
-    "dockerImageTag" : "dockerImageTag",
-    "releaseDate" : "2000-01-23",
-    "dockerRepository" : "dockerRepository",
-    "supportsDbt" : true,
-    "name" : "name",
-    "icon" : "icon",
-    "normalizationConfig" : {
-      "normalizationIntegrationType" : "normalizationIntegrationType",
-      "normalizationRepository" : "normalizationRepository",
-      "normalizationTag" : "normalizationTag",
-      "supported" : false
-    },
-    "protocolVersion" : "protocolVersion",
-    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - DestinationDefinitionReadList -
-
-
-
- Up - 
post /v1/destination_definitions/list_latest
-
List the latest destinationDefinitions Airbyte supports (listLatestDestinationDefinitions)
-
Guaranteed to retrieve the latest information on supported destinations.
- - - - - - - -

Return type

-
- DestinationDefinitionReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "destinationDefinitions" : [ {
-    "resourceRequirements" : {
-      "default" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      },
-      "jobSpecific" : [ {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      }, {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      } ]
-    },
-    "documentationUrl" : "https://openapi-generator.tech",
-    "dockerImageTag" : "dockerImageTag",
-    "releaseDate" : "2000-01-23",
-    "dockerRepository" : "dockerRepository",
-    "supportsDbt" : true,
-    "name" : "name",
-    "icon" : "icon",
-    "normalizationConfig" : {
-      "normalizationIntegrationType" : "normalizationIntegrationType",
-      "normalizationRepository" : "normalizationRepository",
-      "normalizationTag" : "normalizationTag",
-      "supported" : false
-    },
-    "protocolVersion" : "protocolVersion",
-    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "resourceRequirements" : {
-      "default" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      },
-      "jobSpecific" : [ {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      }, {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      } ]
-    },
-    "documentationUrl" : "https://openapi-generator.tech",
-    "dockerImageTag" : "dockerImageTag",
-    "releaseDate" : "2000-01-23",
-    "dockerRepository" : "dockerRepository",
-    "supportsDbt" : true,
-    "name" : "name",
-    "icon" : "icon",
-    "normalizationConfig" : {
-      "normalizationIntegrationType" : "normalizationIntegrationType",
-      "normalizationRepository" : "normalizationRepository",
-      "normalizationTag" : "normalizationTag",
-      "supported" : false
-    },
-    "protocolVersion" : "protocolVersion",
-    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - DestinationDefinitionReadList -
-
-
-
- Up - 
post /v1/destination_definitions/list_private
-
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. (listPrivateDestinationDefinitions)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WorkspaceIdRequestBody WorkspaceIdRequestBody (optional)
- -
Body Parameter —
- -
- - - - -

Return type

-
- PrivateDestinationDefinitionReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "destinationDefinitions" : [ {
-    "destinationDefinition" : {
-      "resourceRequirements" : {
-        "default" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        },
-        "jobSpecific" : [ {
-          "resourceRequirements" : {
-            "cpu_limit" : "cpu_limit",
-            "memory_request" : "memory_request",
-            "memory_limit" : "memory_limit",
-            "cpu_request" : "cpu_request"
-          }
-        }, {
-          "resourceRequirements" : {
-            "cpu_limit" : "cpu_limit",
-            "memory_request" : "memory_request",
-            "memory_limit" : "memory_limit",
-            "cpu_request" : "cpu_request"
-          }
-        } ]
-      },
-      "documentationUrl" : "https://openapi-generator.tech",
-      "dockerImageTag" : "dockerImageTag",
-      "releaseDate" : "2000-01-23",
-      "dockerRepository" : "dockerRepository",
-      "supportsDbt" : true,
-      "name" : "name",
-      "icon" : "icon",
-      "normalizationConfig" : {
-        "normalizationIntegrationType" : "normalizationIntegrationType",
-        "normalizationRepository" : "normalizationRepository",
-        "normalizationTag" : "normalizationTag",
-        "supported" : false
-      },
-      "protocolVersion" : "protocolVersion",
-      "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-    },
-    "granted" : true
-  }, {
-    "destinationDefinition" : {
-      "resourceRequirements" : {
-        "default" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        },
-        "jobSpecific" : [ {
-          "resourceRequirements" : {
-            "cpu_limit" : "cpu_limit",
-            "memory_request" : "memory_request",
-            "memory_limit" : "memory_limit",
-            "cpu_request" : "cpu_request"
-          }
-        }, {
-          "resourceRequirements" : {
-            "cpu_limit" : "cpu_limit",
-            "memory_request" : "memory_request",
-            "memory_limit" : "memory_limit",
-            "cpu_request" : "cpu_request"
-          }
-        } ]
-      },
-      "documentationUrl" : "https://openapi-generator.tech",
-      "dockerImageTag" : "dockerImageTag",
-      "releaseDate" : "2000-01-23",
-      "dockerRepository" : "dockerRepository",
-      "supportsDbt" : true,
-      "name" : "name",
-      "icon" : "icon",
-      "normalizationConfig" : {
-        "normalizationIntegrationType" : "normalizationIntegrationType",
-        "normalizationRepository" : "normalizationRepository",
-        "normalizationTag" : "normalizationTag",
-        "supported" : false
-      },
-      "protocolVersion" : "protocolVersion",
-      "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-    },
-    "granted" : true
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - PrivateDestinationDefinitionReadList -
-
-
-
- Up - 
post /v1/destination_definitions/revoke_definition
-
revoke a grant to a private, non-custom destinationDefinition from a given workspace (revokeDestinationDefinitionFromWorkspace)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationDefinitionIdWithWorkspaceId DestinationDefinitionIdWithWorkspaceId (required)
- -
Body Parameter —
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

204

- The resource was deleted successfully. - -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destination_definitions/update
-
Update destinationDefinition (updateDestinationDefinition)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationDefinitionUpdate DestinationDefinitionUpdate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- DestinationDefinitionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "resourceRequirements" : {
-    "default" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
-    },
-    "jobSpecific" : [ {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    }, {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    } ]
-  },
-  "documentationUrl" : "https://openapi-generator.tech",
-  "dockerImageTag" : "dockerImageTag",
-  "releaseDate" : "2000-01-23",
-  "dockerRepository" : "dockerRepository",
-  "supportsDbt" : true,
-  "name" : "name",
-  "icon" : "icon",
-  "normalizationConfig" : {
-    "normalizationIntegrationType" : "normalizationIntegrationType",
-    "normalizationRepository" : "normalizationRepository",
-    "normalizationTag" : "normalizationTag",
-    "supported" : false
-  },
-  "protocolVersion" : "protocolVersion",
-  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - DestinationDefinitionRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-

DestinationDefinitionSpecification

-
-
- Up - 
post /v1/destination_definition_specifications/get
-
Get specification for a destinationDefinition (getDestinationDefinitionSpecification)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationDefinitionIdWithWorkspaceId DestinationDefinitionIdWithWorkspaceId (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- DestinationDefinitionSpecificationRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "documentationUrl" : "documentationUrl",
-  "connectionSpecification" : {
-    "user" : {
-      "type" : "string"
-    }
-  },
-  "supportedDestinationSyncModes" : [ null, null ],
-  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "advancedAuth" : {
-    "predicateValue" : "predicateValue",
-    "oauthConfigSpecification" : { },
-    "predicateKey" : [ "predicateKey", "predicateKey" ],
-    "authFlowType" : "oauth2.0"
-  },
-  "jobInfo" : {
-    "createdAt" : 0,
-    "connectorConfigurationUpdated" : false,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "failureReason" : {
-      "retryable" : true,
-      "stacktrace" : "stacktrace",
-      "internalMessage" : "internalMessage",
-      "externalMessage" : "externalMessage",
-      "timestamp" : 1
-    },
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    },
-    "succeeded" : true
-  }
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - DestinationDefinitionSpecificationRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destination_definition_specifications/get_for_destination
-
Get specification for a destination (getSpecificationForDestinationId)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationIdRequestBody DestinationIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- DestinationDefinitionSpecificationRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "documentationUrl" : "documentationUrl",
-  "connectionSpecification" : {
-    "user" : {
-      "type" : "string"
-    }
-  },
-  "supportedDestinationSyncModes" : [ null, null ],
-  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "advancedAuth" : {
-    "predicateValue" : "predicateValue",
-    "oauthConfigSpecification" : { },
-    "predicateKey" : [ "predicateKey", "predicateKey" ],
-    "authFlowType" : "oauth2.0"
-  },
-  "jobInfo" : {
-    "createdAt" : 0,
-    "connectorConfigurationUpdated" : false,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "failureReason" : {
-      "retryable" : true,
-      "stacktrace" : "stacktrace",
-      "internalMessage" : "internalMessage",
-      "externalMessage" : "externalMessage",
-      "timestamp" : 1
-    },
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    },
-    "succeeded" : true
-  }
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - DestinationDefinitionSpecificationRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-

DestinationOauth

-
-
- Up - 
post /v1/destination_oauths/complete_oauth
-
Given a destination def ID generate an access/refresh token etc. (completeDestinationOAuth)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
CompleteDestinationOAuthRequest CompleteDestinationOAuthRequest (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- CompleteOAuthResponse - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "auth_payload" : {
-    "key" : ""
-  },
-  "request_error" : "request_error",
-  "request_succeeded" : true
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - CompleteOAuthResponse -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destination_oauths/get_consent_url
-
Given a destination connector definition ID, return the URL to the consent screen where to redirect the user to. (getDestinationOAuthConsent)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationOauthConsentRequest DestinationOauthConsentRequest (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- OAuthConsentRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "consentUrl" : "consentUrl"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - OAuthConsentRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/destination_oauths/oauth_params/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 developer_token, client_id, and client_secret without the user having to know about these variables. (setInstancewideDestinationOauthParams)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SetInstancewideDestinationOauthParamsRequestBody SetInstancewideDestinationOauthParamsRequestBody (required)
- -
Body Parameter —
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful - -

400

- Exception occurred; see message for details. - KnownExceptionInfo -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -
-
-

Health

-
-
- Up - 
get /v1/health
-
Health Check (getHealthCheck)
-
- - - - - - - -

Return type

-
- HealthCheckRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "available" : true
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - HealthCheckRead -
-
-

Internal

-
-
- Up - 
post /v1/state/create_or_update
-
Create or update the state for a connection. (createOrUpdateState)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectionStateCreateOrUpdate ConnectionStateCreateOrUpdate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- ConnectionState - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "globalState" : {
-    "streamStates" : [ {
-      "streamDescriptor" : {
-        "name" : "name",
-        "namespace" : "namespace"
-      }
-    }, {
-      "streamDescriptor" : {
-        "name" : "name",
-        "namespace" : "namespace"
-      }
-    } ]
-  },
-  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "streamState" : [ {
-    "streamDescriptor" : {
-      "name" : "name",
-      "namespace" : "namespace"
-    }
-  }, {
-    "streamDescriptor" : {
-      "name" : "name",
-      "namespace" : "namespace"
-    }
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - ConnectionState -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/jobs/get_normalization_status
-
Get normalization status to determine if we can bypass normalization phase (getAttemptNormalizationStatusesForJob)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
JobIdRequestBody JobIdRequestBody (optional)
- -
Body Parameter —
- -
- - - - -

Return type

-
- AttemptNormalizationStatusReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "attemptNormalizationStatuses" : [ {
-    "attemptNumber" : 0,
-    "recordsCommitted" : 6,
-    "hasRecordsCommitted" : true,
-    "hasNormalizationFailed" : true
-  }, {
-    "attemptNumber" : 0,
-    "recordsCommitted" : 6,
-    "hasRecordsCommitted" : true,
-    "hasNormalizationFailed" : true
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - AttemptNormalizationStatusReadList -
-
-
-
- Up - 
post /v1/attempt/save_stats
-
For worker to set sync stats of a running attempt. (saveStats)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SaveStatsRequestBody SaveStatsRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- InternalOperationResult - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "succeeded" : true
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful Operation - InternalOperationResult -
-
-
-
- Up - 
post /v1/attempt/save_sync_config
-
For worker to save the AttemptSyncConfig for an attempt. (saveSyncConfig)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SaveAttemptSyncConfigRequestBody SaveAttemptSyncConfigRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- InternalOperationResult - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "succeeded" : true
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful Operation - InternalOperationResult -
-
-
-
- Up - 
post /v1/attempt/set_workflow_in_attempt
-
For worker to register the workflow id in attempt. (setWorkflowInAttempt)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SetWorkflowInAttemptRequestBody SetWorkflowInAttemptRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- InternalOperationResult - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "succeeded" : true
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful Operation - InternalOperationResult -
-
-
-
- Up - 
post /v1/sources/write_discover_catalog_result
-
Should only called from worker, to write result from discover activity back to DB. (writeDiscoverCatalogResult)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceDiscoverSchemaWriteRequestBody SourceDiscoverSchemaWriteRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- DiscoverCatalogResult - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "catalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful Operation - DiscoverCatalogResult -
-
-

Jobs

-
-
- Up - 
post /v1/jobs/cancel
-
Cancels a job (cancelJob)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
JobIdRequestBody JobIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- JobInfoRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "job" : {
-    "createdAt" : 6,
-    "enabledStreams" : [ {
-      "name" : "name",
-      "namespace" : "namespace"
-    }, {
-      "name" : "name",
-      "namespace" : "namespace"
-    } ],
-    "configId" : "configId",
-    "startedAt" : 5,
-    "id" : 0,
-    "resetConfig" : {
-      "streamsToReset" : [ {
-        "name" : "name",
-        "namespace" : "namespace"
-      }, {
-        "name" : "name",
-        "namespace" : "namespace"
-      } ]
-    },
-    "updatedAt" : 1
-  },
-  "attempts" : [ {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
-  }, {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - JobInfoRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/jobs/get_normalization_status
-
Get normalization status to determine if we can bypass normalization phase (getAttemptNormalizationStatusesForJob)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
JobIdRequestBody JobIdRequestBody (optional)
- -
Body Parameter —
- -
- - - - -

Return type

-
- AttemptNormalizationStatusReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "attemptNormalizationStatuses" : [ {
-    "attemptNumber" : 0,
-    "recordsCommitted" : 6,
-    "hasRecordsCommitted" : true,
-    "hasNormalizationFailed" : true
-  }, {
-    "attemptNumber" : 0,
-    "recordsCommitted" : 6,
-    "hasRecordsCommitted" : true,
-    "hasNormalizationFailed" : true
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - AttemptNormalizationStatusReadList -
-
-
-
- Up - 
post /v1/jobs/get_debug_info
-
Gets all information needed to debug this job (getJobDebugInfo)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
JobIdRequestBody JobIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- JobDebugInfoRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "workflowState" : {
-    "running" : true
-  },
-  "job" : {
-    "configId" : "configId",
-    "sourceDefinition" : {
-      "resourceRequirements" : {
-        "default" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        },
-        "jobSpecific" : [ {
-          "resourceRequirements" : {
-            "cpu_limit" : "cpu_limit",
-            "memory_request" : "memory_request",
-            "memory_limit" : "memory_limit",
-            "cpu_request" : "cpu_request"
-          }
-        }, {
-          "resourceRequirements" : {
-            "cpu_limit" : "cpu_limit",
-            "memory_request" : "memory_request",
-            "memory_limit" : "memory_limit",
-            "cpu_request" : "cpu_request"
-          }
-        } ]
-      },
-      "documentationUrl" : "https://openapi-generator.tech",
-      "dockerImageTag" : "dockerImageTag",
-      "releaseDate" : "2000-01-23",
-      "sourceType" : "api",
-      "dockerRepository" : "dockerRepository",
-      "name" : "name",
-      "icon" : "icon",
-      "protocolVersion" : "protocolVersion",
-      "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-      "maxSecondsBetweenMessages" : 0
-    },
-    "airbyteVersion" : "airbyteVersion",
-    "id" : 0,
-    "destinationDefinition" : {
-      "resourceRequirements" : {
-        "default" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        },
-        "jobSpecific" : [ {
-          "resourceRequirements" : {
-            "cpu_limit" : "cpu_limit",
-            "memory_request" : "memory_request",
-            "memory_limit" : "memory_limit",
-            "cpu_request" : "cpu_request"
-          }
-        }, {
-          "resourceRequirements" : {
-            "cpu_limit" : "cpu_limit",
-            "memory_request" : "memory_request",
-            "memory_limit" : "memory_limit",
-            "cpu_request" : "cpu_request"
-          }
-        } ]
-      },
-      "documentationUrl" : "https://openapi-generator.tech",
-      "dockerImageTag" : "dockerImageTag",
-      "releaseDate" : "2000-01-23",
-      "dockerRepository" : "dockerRepository",
-      "supportsDbt" : true,
-      "name" : "name",
-      "icon" : "icon",
-      "normalizationConfig" : {
-        "normalizationIntegrationType" : "normalizationIntegrationType",
-        "normalizationRepository" : "normalizationRepository",
-        "normalizationTag" : "normalizationTag",
-        "supported" : false
-      },
-      "protocolVersion" : "protocolVersion",
-      "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-    }
-  },
-  "attempts" : [ {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
-  }, {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - JobDebugInfoRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/jobs/get
-
Get information about a job (getJobInfo)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
JobIdRequestBody JobIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- JobInfoRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "job" : {
-    "createdAt" : 6,
-    "enabledStreams" : [ {
-      "name" : "name",
-      "namespace" : "namespace"
-    }, {
-      "name" : "name",
-      "namespace" : "namespace"
-    } ],
-    "configId" : "configId",
-    "startedAt" : 5,
-    "id" : 0,
-    "resetConfig" : {
-      "streamsToReset" : [ {
-        "name" : "name",
-        "namespace" : "namespace"
-      }, {
-        "name" : "name",
-        "namespace" : "namespace"
-      } ]
-    },
-    "updatedAt" : 1
-  },
-  "attempts" : [ {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
-  }, {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - JobInfoRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/jobs/get_light
-
Get information about a job excluding attempt info and logs (getJobInfoLight)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
JobIdRequestBody JobIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- JobInfoLightRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "job" : {
-    "createdAt" : 6,
-    "enabledStreams" : [ {
-      "name" : "name",
-      "namespace" : "namespace"
-    }, {
-      "name" : "name",
-      "namespace" : "namespace"
-    } ],
-    "configId" : "configId",
-    "startedAt" : 5,
-    "id" : 0,
-    "resetConfig" : {
-      "streamsToReset" : [ {
-        "name" : "name",
-        "namespace" : "namespace"
-      }, {
-        "name" : "name",
-        "namespace" : "namespace"
-      } ]
-    },
-    "updatedAt" : 1
-  }
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - JobInfoLightRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/jobs/get_without_logs
-
Get information about a job excluding logs (getJobInfoWithoutLogs)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
JobIdRequestBody JobIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- JobInfoRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "job" : {
-    "createdAt" : 6,
-    "enabledStreams" : [ {
-      "name" : "name",
-      "namespace" : "namespace"
-    }, {
-      "name" : "name",
-      "namespace" : "namespace"
-    } ],
-    "configId" : "configId",
-    "startedAt" : 5,
-    "id" : 0,
-    "resetConfig" : {
-      "streamsToReset" : [ {
-        "name" : "name",
-        "namespace" : "namespace"
-      }, {
-        "name" : "name",
-        "namespace" : "namespace"
-      } ]
-    },
-    "updatedAt" : 1
-  },
-  "attempts" : [ {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
-  }, {
-    "attempt" : {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    },
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    }
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - JobInfoRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/jobs/get_last_replication_job
-
(getLastReplicationJob)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectionIdRequestBody ConnectionIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- JobOptionalRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "job" : {
-    "createdAt" : 6,
-    "enabledStreams" : [ {
-      "name" : "name",
-      "namespace" : "namespace"
-    }, {
-      "name" : "name",
-      "namespace" : "namespace"
-    } ],
-    "configId" : "configId",
-    "startedAt" : 5,
-    "id" : 0,
-    "resetConfig" : {
-      "streamsToReset" : [ {
-        "name" : "name",
-        "namespace" : "namespace"
-      }, {
-        "name" : "name",
-        "namespace" : "namespace"
-      } ]
-    },
-    "updatedAt" : 1
-  }
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - JobOptionalRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/jobs/list
-
Returns recent jobs for a connection. Jobs are returned in descending order by createdAt. (listJobsFor)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
JobListRequestBody JobListRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- JobReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "totalJobCount" : 0,
-  "jobs" : [ {
-    "job" : {
-      "createdAt" : 6,
-      "enabledStreams" : [ {
-        "name" : "name",
-        "namespace" : "namespace"
-      }, {
-        "name" : "name",
-        "namespace" : "namespace"
-      } ],
-      "configId" : "configId",
-      "startedAt" : 5,
-      "id" : 0,
-      "resetConfig" : {
-        "streamsToReset" : [ {
-          "name" : "name",
-          "namespace" : "namespace"
-        }, {
-          "name" : "name",
-          "namespace" : "namespace"
-        } ]
-      },
-      "updatedAt" : 1
-    },
-    "attempts" : [ {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    }, {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    } ]
-  }, {
-    "job" : {
-      "createdAt" : 6,
-      "enabledStreams" : [ {
-        "name" : "name",
-        "namespace" : "namespace"
-      }, {
-        "name" : "name",
-        "namespace" : "namespace"
-      } ],
-      "configId" : "configId",
-      "startedAt" : 5,
-      "id" : 0,
-      "resetConfig" : {
-        "streamsToReset" : [ {
-          "name" : "name",
-          "namespace" : "namespace"
-        }, {
-          "name" : "name",
-          "namespace" : "namespace"
-        } ]
-      },
-      "updatedAt" : 1
-    },
-    "attempts" : [ {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    }, {
-      "totalStats" : {
-        "stateMessagesEmitted" : 1,
-        "recordsCommitted" : 1,
-        "bytesEmitted" : 7,
-        "estimatedBytes" : 7,
-        "estimatedRecords" : 6,
-        "recordsEmitted" : 4,
-        "bytesCommitted" : 1
-      },
-      "failureSummary" : {
-        "failures" : [ {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        }, {
-          "retryable" : true,
-          "stacktrace" : "stacktrace",
-          "internalMessage" : "internalMessage",
-          "externalMessage" : "externalMessage",
-          "timestamp" : 1
-        } ],
-        "partialSuccess" : true
-      },
-      "createdAt" : 2,
-      "bytesSynced" : 3,
-      "endedAt" : 9,
-      "streamStats" : [ {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      }, {
-        "stats" : {
-          "stateMessagesEmitted" : 1,
-          "recordsCommitted" : 1,
-          "bytesEmitted" : 7,
-          "estimatedBytes" : 7,
-          "estimatedRecords" : 6,
-          "recordsEmitted" : 4,
-          "bytesCommitted" : 1
-        },
-        "streamNamespace" : "streamNamespace",
-        "streamName" : "streamName"
-      } ],
-      "id" : 5,
-      "recordsSynced" : 2,
-      "updatedAt" : 7
-    } ]
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - JobReadList -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-

Logs

-
-
- Up - 
post /v1/logs/get
-
Get logs (getLogs)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
LogsRequestBody LogsRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- - File -
- - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • text/plain
    • -
  • application/json
    • -
- -

Responses

-

200

- Returns the log file - File -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-

Notifications

-
-
- Up - 
post /v1/notifications/try
-
Try sending a notifications (tryNotificationConfig)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
Notification Notification (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- NotificationRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "message" : "message",
-  "status" : "succeeded"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - NotificationRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-

Openapi

-
-
- Up - 
get /v1/openapi
-
Returns the openapi specification (getOpenApiSpec)
-
- - - - - - - -

Return type

-
- - File -
- - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • text/plain
    • -
- -

Responses

-

200

- Returns the openapi specification file - File -
-
-

Operation

-
-
- Up - 
post /v1/operations/check
-
Check if an operation to be created is valid (checkOperation)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
OperatorConfiguration OperatorConfiguration (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- CheckOperationRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "message" : "message",
-  "status" : "succeeded"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - CheckOperationRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/operations/create
-
Create an operation to be applied as part of a connection pipeline (createOperation)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
OperationCreate OperationCreate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- OperationRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "name" : "name",
-  "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "operatorConfiguration" : {
-    "webhook" : {
-      "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-      "dbtCloud" : {
-        "accountId" : 0,
-        "jobId" : 6
-      },
-      "executionUrl" : "executionUrl",
-      "executionBody" : "executionBody",
-      "webhookType" : "dbtCloud"
-    },
-    "normalization" : {
-      "option" : "basic"
-    },
-    "dbt" : {
-      "gitRepoBranch" : "gitRepoBranch",
-      "dockerImage" : "dockerImage",
-      "dbtArguments" : "dbtArguments",
-      "gitRepoUrl" : "gitRepoUrl"
-    }
-  },
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - OperationRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/operations/delete
-
Delete an operation (deleteOperation)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
OperationIdRequestBody OperationIdRequestBody (required)
- -
Body Parameter —
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

204

- The resource was deleted successfully. - -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/operations/get
-
Returns an operation (getOperation)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
OperationIdRequestBody OperationIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- OperationRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "name" : "name",
-  "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "operatorConfiguration" : {
-    "webhook" : {
-      "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-      "dbtCloud" : {
-        "accountId" : 0,
-        "jobId" : 6
-      },
-      "executionUrl" : "executionUrl",
-      "executionBody" : "executionBody",
-      "webhookType" : "dbtCloud"
-    },
-    "normalization" : {
-      "option" : "basic"
-    },
-    "dbt" : {
-      "gitRepoBranch" : "gitRepoBranch",
-      "dockerImage" : "dockerImage",
-      "dbtArguments" : "dbtArguments",
-      "gitRepoUrl" : "gitRepoUrl"
-    }
-  },
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - OperationRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/operations/list
-
Returns all operations for a connection. (listOperationsForConnection)
-
List operations for connection.
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectionIdRequestBody ConnectionIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- OperationReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "operations" : [ {
-    "name" : "name",
-    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "operatorConfiguration" : {
-      "webhook" : {
-        "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-        "dbtCloud" : {
-          "accountId" : 0,
-          "jobId" : 6
-        },
-        "executionUrl" : "executionUrl",
-        "executionBody" : "executionBody",
-        "webhookType" : "dbtCloud"
-      },
-      "normalization" : {
-        "option" : "basic"
-      },
-      "dbt" : {
-        "gitRepoBranch" : "gitRepoBranch",
-        "dockerImage" : "dockerImage",
-        "dbtArguments" : "dbtArguments",
-        "gitRepoUrl" : "gitRepoUrl"
-      }
-    },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "name" : "name",
-    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "operatorConfiguration" : {
-      "webhook" : {
-        "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-        "dbtCloud" : {
-          "accountId" : 0,
-          "jobId" : 6
-        },
-        "executionUrl" : "executionUrl",
-        "executionBody" : "executionBody",
-        "webhookType" : "dbtCloud"
-      },
-      "normalization" : {
-        "option" : "basic"
-      },
-      "dbt" : {
-        "gitRepoBranch" : "gitRepoBranch",
-        "dockerImage" : "dockerImage",
-        "dbtArguments" : "dbtArguments",
-        "gitRepoUrl" : "gitRepoUrl"
-      }
-    },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - OperationReadList -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/operations/update
-
Update an operation (updateOperation)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
OperationUpdate OperationUpdate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- OperationRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "name" : "name",
-  "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "operatorConfiguration" : {
-    "webhook" : {
-      "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-      "dbtCloud" : {
-        "accountId" : 0,
-        "jobId" : 6
-      },
-      "executionUrl" : "executionUrl",
-      "executionBody" : "executionBody",
-      "webhookType" : "dbtCloud"
-    },
-    "normalization" : {
-      "option" : "basic"
-    },
-    "dbt" : {
-      "gitRepoBranch" : "gitRepoBranch",
-      "dockerImage" : "dockerImage",
-      "dbtArguments" : "dbtArguments",
-      "gitRepoUrl" : "gitRepoUrl"
-    }
-  },
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - OperationRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-

Scheduler

-
-
- Up - 
post /v1/scheduler/destinations/check_connection
-
Run check connection for a given destination configuration (executeDestinationCheckConnection)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
DestinationCoreConfig DestinationCoreConfig (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- CheckConnectionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "message" : "message",
-  "jobInfo" : {
-    "createdAt" : 0,
-    "connectorConfigurationUpdated" : false,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "failureReason" : {
-      "retryable" : true,
-      "stacktrace" : "stacktrace",
-      "internalMessage" : "internalMessage",
-      "externalMessage" : "externalMessage",
-      "timestamp" : 1
-    },
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    },
-    "succeeded" : true
-  },
-  "status" : "succeeded"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - CheckConnectionRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/scheduler/sources/check_connection
-
Run check connection for a given source configuration (executeSourceCheckConnection)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceCoreConfig SourceCoreConfig (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- CheckConnectionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "message" : "message",
-  "jobInfo" : {
-    "createdAt" : 0,
-    "connectorConfigurationUpdated" : false,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "failureReason" : {
-      "retryable" : true,
-      "stacktrace" : "stacktrace",
-      "internalMessage" : "internalMessage",
-      "externalMessage" : "externalMessage",
-      "timestamp" : 1
-    },
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    },
-    "succeeded" : true
-  },
-  "status" : "succeeded"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - CheckConnectionRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/scheduler/sources/discover_schema
-
Run discover schema for a given source a source configuration (executeSourceDiscoverSchema)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceCoreConfig SourceCoreConfig (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- SourceDiscoverSchemaRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "catalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "breakingChange" : true,
-  "catalog" : {
-    "streams" : [ {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "suggested" : true,
-        "fieldSelectionEnabled" : true,
-        "selectedFields" : [ {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        }, {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        } ],
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-      }
-    }, {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "suggested" : true,
-        "fieldSelectionEnabled" : true,
-        "selectedFields" : [ {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        }, {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        } ],
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-      }
-    } ]
-  },
-  "jobInfo" : {
-    "createdAt" : 0,
-    "connectorConfigurationUpdated" : false,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "failureReason" : {
-      "retryable" : true,
-      "stacktrace" : "stacktrace",
-      "internalMessage" : "internalMessage",
-      "externalMessage" : "externalMessage",
-      "timestamp" : 1
-    },
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    },
-    "succeeded" : true
-  },
-  "catalogDiff" : {
-    "transforms" : [ {
-      "streamDescriptor" : {
-        "name" : "name",
-        "namespace" : "namespace"
-      },
-      "transformType" : "add_stream",
-      "updateStream" : [ {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      }, {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      } ]
-    }, {
-      "streamDescriptor" : {
-        "name" : "name",
-        "namespace" : "namespace"
-      },
-      "transformType" : "add_stream",
-      "updateStream" : [ {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      }, {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      } ]
-    } ]
-  }
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceDiscoverSchemaRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-

Source

-
-
- Up - 
post /v1/sources/apply_schema_changes
-
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. (applySchemaChangeForSource)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceAutoPropagateChange SourceAutoPropagateChange (required)
- -
Body Parameter —
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

204

- The schema was properly auto propagate - -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/sources/check_connection
-
Check connection to the source (checkConnectionToSource)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceIdRequestBody SourceIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- CheckConnectionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "message" : "message",
-  "jobInfo" : {
-    "createdAt" : 0,
-    "connectorConfigurationUpdated" : false,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "failureReason" : {
-      "retryable" : true,
-      "stacktrace" : "stacktrace",
-      "internalMessage" : "internalMessage",
-      "externalMessage" : "externalMessage",
-      "timestamp" : 1
-    },
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    },
-    "succeeded" : true
-  },
-  "status" : "succeeded"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - CheckConnectionRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/sources/check_connection_for_update
-
Check connection for a proposed update to a source (checkConnectionToSourceForUpdate)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceUpdate SourceUpdate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- CheckConnectionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "message" : "message",
-  "jobInfo" : {
-    "createdAt" : 0,
-    "connectorConfigurationUpdated" : false,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "failureReason" : {
-      "retryable" : true,
-      "stacktrace" : "stacktrace",
-      "internalMessage" : "internalMessage",
-      "externalMessage" : "externalMessage",
-      "timestamp" : 1
-    },
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    },
-    "succeeded" : true
-  },
-  "status" : "succeeded"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - CheckConnectionRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/sources/clone
-
Clone source (cloneSource)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceCloneRequestBody SourceCloneRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- SourceRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "connectionConfiguration" : {
-    "user" : "charles"
-  },
-  "name" : "name",
-  "icon" : "icon",
-  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "sourceName" : "sourceName",
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/sources/create
-
Create a source (createSource)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceCreate SourceCreate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- SourceRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "connectionConfiguration" : {
-    "user" : "charles"
-  },
-  "name" : "name",
-  "icon" : "icon",
-  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "sourceName" : "sourceName",
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/sources/delete
-
Delete a source (deleteSource)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceIdRequestBody SourceIdRequestBody (required)
- -
Body Parameter —
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

204

- The resource was deleted successfully. - -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/sources/discover_schema
-
Discover the schema catalog of the source (discoverSchemaForSource)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceDiscoverSchemaRequestBody SourceDiscoverSchemaRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- SourceDiscoverSchemaRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "catalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "breakingChange" : true,
-  "catalog" : {
-    "streams" : [ {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "suggested" : true,
-        "fieldSelectionEnabled" : true,
-        "selectedFields" : [ {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        }, {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        } ],
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-      }
-    }, {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "suggested" : true,
-        "fieldSelectionEnabled" : true,
-        "selectedFields" : [ {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        }, {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        } ],
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-      }
-    } ]
-  },
-  "jobInfo" : {
-    "createdAt" : 0,
-    "connectorConfigurationUpdated" : false,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "failureReason" : {
-      "retryable" : true,
-      "stacktrace" : "stacktrace",
-      "internalMessage" : "internalMessage",
-      "externalMessage" : "externalMessage",
-      "timestamp" : 1
-    },
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    },
-    "succeeded" : true
-  },
-  "catalogDiff" : {
-    "transforms" : [ {
-      "streamDescriptor" : {
-        "name" : "name",
-        "namespace" : "namespace"
-      },
-      "transformType" : "add_stream",
-      "updateStream" : [ {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      }, {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      } ]
-    }, {
-      "streamDescriptor" : {
-        "name" : "name",
-        "namespace" : "namespace"
-      },
-      "transformType" : "add_stream",
-      "updateStream" : [ {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      }, {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      } ]
-    } ]
-  }
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceDiscoverSchemaRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/sources/most_recent_source_actor_catalog
-
Get most recent ActorCatalog for source (getMostRecentSourceActorCatalog)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceIdRequestBody SourceIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- ActorCatalogWithUpdatedAt - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "catalog" : "{}",
-  "updatedAt" : 0
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - ActorCatalogWithUpdatedAt -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/sources/get
-
Get source (getSource)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceIdRequestBody SourceIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- SourceRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "connectionConfiguration" : {
-    "user" : "charles"
-  },
-  "name" : "name",
-  "icon" : "icon",
-  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "sourceName" : "sourceName",
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/sources/list
-
List sources for workspace (listSourcesForWorkspace)
-
List sources for workspace. Does not return deleted sources.
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- SourceReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sources" : [ {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "name" : "name",
-    "icon" : "icon",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceName" : "sourceName",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "name" : "name",
-    "icon" : "icon",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceName" : "sourceName",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceReadList -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/sources/partial_update
-
Partially update a source (partialUpdateSource)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
PartialSourceUpdate PartialSourceUpdate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- SourceRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "connectionConfiguration" : {
-    "user" : "charles"
-  },
-  "name" : "name",
-  "icon" : "icon",
-  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "sourceName" : "sourceName",
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/sources/search
-
Search sources (searchSources)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceSearch SourceSearch (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- SourceReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sources" : [ {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "name" : "name",
-    "icon" : "icon",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceName" : "sourceName",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "name" : "name",
-    "icon" : "icon",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceName" : "sourceName",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceReadList -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/sources/update
-
Update a source (updateSource)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceUpdate SourceUpdate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- SourceRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "connectionConfiguration" : {
-    "user" : "charles"
-  },
-  "name" : "name",
-  "icon" : "icon",
-  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "sourceName" : "sourceName",
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/sources/write_discover_catalog_result
-
Should only called from worker, to write result from discover activity back to DB. (writeDiscoverCatalogResult)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceDiscoverSchemaWriteRequestBody SourceDiscoverSchemaWriteRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- DiscoverCatalogResult - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "catalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful Operation - DiscoverCatalogResult -
-
-

SourceDefinition

-
-
- Up - 
post /v1/source_definitions/create_custom
-
Creates a custom sourceDefinition for the given workspace (createCustomSourceDefinition)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
CustomSourceDefinitionCreate CustomSourceDefinitionCreate (optional)
- -
Body Parameter —
- -
- - - - -

Return type

-
- SourceDefinitionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "resourceRequirements" : {
-    "default" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
-    },
-    "jobSpecific" : [ {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    }, {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    } ]
-  },
-  "documentationUrl" : "https://openapi-generator.tech",
-  "dockerImageTag" : "dockerImageTag",
-  "releaseDate" : "2000-01-23",
-  "sourceType" : "api",
-  "dockerRepository" : "dockerRepository",
-  "name" : "name",
-  "icon" : "icon",
-  "protocolVersion" : "protocolVersion",
-  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "maxSecondsBetweenMessages" : 0
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceDefinitionRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/source_definitions/delete
-
Delete a source definition (deleteSourceDefinition)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceDefinitionIdRequestBody SourceDefinitionIdRequestBody (required)
- -
Body Parameter —
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

204

- The resource was deleted successfully. - -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/source_definitions/get
-
Get source (getSourceDefinition)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceDefinitionIdRequestBody SourceDefinitionIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- SourceDefinitionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "resourceRequirements" : {
-    "default" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
-    },
-    "jobSpecific" : [ {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    }, {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    } ]
-  },
-  "documentationUrl" : "https://openapi-generator.tech",
-  "dockerImageTag" : "dockerImageTag",
-  "releaseDate" : "2000-01-23",
-  "sourceType" : "api",
-  "dockerRepository" : "dockerRepository",
-  "name" : "name",
-  "icon" : "icon",
-  "protocolVersion" : "protocolVersion",
-  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "maxSecondsBetweenMessages" : 0
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceDefinitionRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/source_definitions/get_for_workspace
-
Get a sourceDefinition that is configured for the given workspace (getSourceDefinitionForWorkspace)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceDefinitionIdWithWorkspaceId SourceDefinitionIdWithWorkspaceId (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- SourceDefinitionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "resourceRequirements" : {
-    "default" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
-    },
-    "jobSpecific" : [ {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    }, {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    } ]
-  },
-  "documentationUrl" : "https://openapi-generator.tech",
-  "dockerImageTag" : "dockerImageTag",
-  "releaseDate" : "2000-01-23",
-  "sourceType" : "api",
-  "dockerRepository" : "dockerRepository",
-  "name" : "name",
-  "icon" : "icon",
-  "protocolVersion" : "protocolVersion",
-  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "maxSecondsBetweenMessages" : 0
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceDefinitionRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/source_definitions/grant_definition
-
grant a private, non-custom sourceDefinition to a given workspace (grantSourceDefinitionToWorkspace)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceDefinitionIdWithWorkspaceId SourceDefinitionIdWithWorkspaceId (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- PrivateSourceDefinitionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sourceDefinition" : {
-    "resourceRequirements" : {
-      "default" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      },
-      "jobSpecific" : [ {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      }, {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      } ]
-    },
-    "documentationUrl" : "https://openapi-generator.tech",
-    "dockerImageTag" : "dockerImageTag",
-    "releaseDate" : "2000-01-23",
-    "sourceType" : "api",
-    "dockerRepository" : "dockerRepository",
-    "name" : "name",
-    "icon" : "icon",
-    "protocolVersion" : "protocolVersion",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "maxSecondsBetweenMessages" : 0
-  },
-  "granted" : true
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - PrivateSourceDefinitionRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/source_definitions/list_latest
-
List the latest sourceDefinitions Airbyte supports (listLatestSourceDefinitions)
-
Guaranteed to retrieve the latest information on supported sources.
- - - - - - - -

Return type

-
- SourceDefinitionReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sourceDefinitions" : [ {
-    "resourceRequirements" : {
-      "default" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      },
-      "jobSpecific" : [ {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      }, {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      } ]
-    },
-    "documentationUrl" : "https://openapi-generator.tech",
-    "dockerImageTag" : "dockerImageTag",
-    "releaseDate" : "2000-01-23",
-    "sourceType" : "api",
-    "dockerRepository" : "dockerRepository",
-    "name" : "name",
-    "icon" : "icon",
-    "protocolVersion" : "protocolVersion",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "maxSecondsBetweenMessages" : 0
-  }, {
-    "resourceRequirements" : {
-      "default" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      },
-      "jobSpecific" : [ {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      }, {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      } ]
-    },
-    "documentationUrl" : "https://openapi-generator.tech",
-    "dockerImageTag" : "dockerImageTag",
-    "releaseDate" : "2000-01-23",
-    "sourceType" : "api",
-    "dockerRepository" : "dockerRepository",
-    "name" : "name",
-    "icon" : "icon",
-    "protocolVersion" : "protocolVersion",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "maxSecondsBetweenMessages" : 0
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceDefinitionReadList -
-
-
-
- Up - 
post /v1/source_definitions/list_private
-
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. (listPrivateSourceDefinitions)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WorkspaceIdRequestBody WorkspaceIdRequestBody (optional)
- -
Body Parameter —
- -
- - - - -

Return type

-
- PrivateSourceDefinitionReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sourceDefinitions" : [ {
-    "sourceDefinition" : {
-      "resourceRequirements" : {
-        "default" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        },
-        "jobSpecific" : [ {
-          "resourceRequirements" : {
-            "cpu_limit" : "cpu_limit",
-            "memory_request" : "memory_request",
-            "memory_limit" : "memory_limit",
-            "cpu_request" : "cpu_request"
-          }
-        }, {
-          "resourceRequirements" : {
-            "cpu_limit" : "cpu_limit",
-            "memory_request" : "memory_request",
-            "memory_limit" : "memory_limit",
-            "cpu_request" : "cpu_request"
-          }
-        } ]
-      },
-      "documentationUrl" : "https://openapi-generator.tech",
-      "dockerImageTag" : "dockerImageTag",
-      "releaseDate" : "2000-01-23",
-      "sourceType" : "api",
-      "dockerRepository" : "dockerRepository",
-      "name" : "name",
-      "icon" : "icon",
-      "protocolVersion" : "protocolVersion",
-      "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-      "maxSecondsBetweenMessages" : 0
-    },
-    "granted" : true
-  }, {
-    "sourceDefinition" : {
-      "resourceRequirements" : {
-        "default" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        },
-        "jobSpecific" : [ {
-          "resourceRequirements" : {
-            "cpu_limit" : "cpu_limit",
-            "memory_request" : "memory_request",
-            "memory_limit" : "memory_limit",
-            "cpu_request" : "cpu_request"
-          }
-        }, {
-          "resourceRequirements" : {
-            "cpu_limit" : "cpu_limit",
-            "memory_request" : "memory_request",
-            "memory_limit" : "memory_limit",
-            "cpu_request" : "cpu_request"
-          }
-        } ]
-      },
-      "documentationUrl" : "https://openapi-generator.tech",
-      "dockerImageTag" : "dockerImageTag",
-      "releaseDate" : "2000-01-23",
-      "sourceType" : "api",
-      "dockerRepository" : "dockerRepository",
-      "name" : "name",
-      "icon" : "icon",
-      "protocolVersion" : "protocolVersion",
-      "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-      "maxSecondsBetweenMessages" : 0
-    },
-    "granted" : true
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - PrivateSourceDefinitionReadList -
-
-
-
- Up - 
post /v1/source_definitions/list
-
List all the sourceDefinitions the current Airbyte deployment is configured to use (listSourceDefinitions)
-
- - - - - - - -

Return type

-
- SourceDefinitionReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sourceDefinitions" : [ {
-    "resourceRequirements" : {
-      "default" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      },
-      "jobSpecific" : [ {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      }, {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      } ]
-    },
-    "documentationUrl" : "https://openapi-generator.tech",
-    "dockerImageTag" : "dockerImageTag",
-    "releaseDate" : "2000-01-23",
-    "sourceType" : "api",
-    "dockerRepository" : "dockerRepository",
-    "name" : "name",
-    "icon" : "icon",
-    "protocolVersion" : "protocolVersion",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "maxSecondsBetweenMessages" : 0
-  }, {
-    "resourceRequirements" : {
-      "default" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      },
-      "jobSpecific" : [ {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      }, {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      } ]
-    },
-    "documentationUrl" : "https://openapi-generator.tech",
-    "dockerImageTag" : "dockerImageTag",
-    "releaseDate" : "2000-01-23",
-    "sourceType" : "api",
-    "dockerRepository" : "dockerRepository",
-    "name" : "name",
-    "icon" : "icon",
-    "protocolVersion" : "protocolVersion",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "maxSecondsBetweenMessages" : 0
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceDefinitionReadList -
-
-
-
- Up - 
post /v1/source_definitions/list_for_workspace
-
List all the sourceDefinitions the given workspace is configured to use (listSourceDefinitionsForWorkspace)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WorkspaceIdRequestBody WorkspaceIdRequestBody (optional)
- -
Body Parameter —
- -
- - - - -

Return type

-
- SourceDefinitionReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sourceDefinitions" : [ {
-    "resourceRequirements" : {
-      "default" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      },
-      "jobSpecific" : [ {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      }, {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      } ]
-    },
-    "documentationUrl" : "https://openapi-generator.tech",
-    "dockerImageTag" : "dockerImageTag",
-    "releaseDate" : "2000-01-23",
-    "sourceType" : "api",
-    "dockerRepository" : "dockerRepository",
-    "name" : "name",
-    "icon" : "icon",
-    "protocolVersion" : "protocolVersion",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "maxSecondsBetweenMessages" : 0
-  }, {
-    "resourceRequirements" : {
-      "default" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      },
-      "jobSpecific" : [ {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      }, {
-        "resourceRequirements" : {
-          "cpu_limit" : "cpu_limit",
-          "memory_request" : "memory_request",
-          "memory_limit" : "memory_limit",
-          "cpu_request" : "cpu_request"
-        }
-      } ]
-    },
-    "documentationUrl" : "https://openapi-generator.tech",
-    "dockerImageTag" : "dockerImageTag",
-    "releaseDate" : "2000-01-23",
-    "sourceType" : "api",
-    "dockerRepository" : "dockerRepository",
-    "name" : "name",
-    "icon" : "icon",
-    "protocolVersion" : "protocolVersion",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "maxSecondsBetweenMessages" : 0
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceDefinitionReadList -
-
-
-
- Up - 
post /v1/source_definitions/revoke_definition
-
revoke a grant to a private, non-custom sourceDefinition from a given workspace (revokeSourceDefinitionFromWorkspace)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceDefinitionIdWithWorkspaceId SourceDefinitionIdWithWorkspaceId (required)
- -
Body Parameter —
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

204

- The resource was deleted successfully. - -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/source_definitions/update
-
Update a sourceDefinition (updateSourceDefinition)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceDefinitionUpdate SourceDefinitionUpdate (optional)
- -
Body Parameter —
- -
- - - - -

Return type

-
- SourceDefinitionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "resourceRequirements" : {
-    "default" : {
-      "cpu_limit" : "cpu_limit",
-      "memory_request" : "memory_request",
-      "memory_limit" : "memory_limit",
-      "cpu_request" : "cpu_request"
-    },
-    "jobSpecific" : [ {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    }, {
-      "resourceRequirements" : {
-        "cpu_limit" : "cpu_limit",
-        "memory_request" : "memory_request",
-        "memory_limit" : "memory_limit",
-        "cpu_request" : "cpu_request"
-      }
-    } ]
-  },
-  "documentationUrl" : "https://openapi-generator.tech",
-  "dockerImageTag" : "dockerImageTag",
-  "releaseDate" : "2000-01-23",
-  "sourceType" : "api",
-  "dockerRepository" : "dockerRepository",
-  "name" : "name",
-  "icon" : "icon",
-  "protocolVersion" : "protocolVersion",
-  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "maxSecondsBetweenMessages" : 0
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceDefinitionRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-

SourceDefinitionSpecification

-
-
- Up - 
post /v1/source_definition_specifications/get
-
Get specification for a SourceDefinition. (getSourceDefinitionSpecification)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceDefinitionIdWithWorkspaceId SourceDefinitionIdWithWorkspaceId (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- SourceDefinitionSpecificationRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "documentationUrl" : "documentationUrl",
-  "connectionSpecification" : {
-    "user" : {
-      "type" : "string"
-    }
-  },
-  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "advancedAuth" : {
-    "predicateValue" : "predicateValue",
-    "oauthConfigSpecification" : { },
-    "predicateKey" : [ "predicateKey", "predicateKey" ],
-    "authFlowType" : "oauth2.0"
-  },
-  "jobInfo" : {
-    "createdAt" : 0,
-    "connectorConfigurationUpdated" : false,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "failureReason" : {
-      "retryable" : true,
-      "stacktrace" : "stacktrace",
-      "internalMessage" : "internalMessage",
-      "externalMessage" : "externalMessage",
-      "timestamp" : 1
-    },
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    },
-    "succeeded" : true
-  }
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceDefinitionSpecificationRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/source_definition_specifications/get_for_source
-
Get specification for a source. (getSpecificationForSourceId)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceIdRequestBody SourceIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- SourceDefinitionSpecificationRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "documentationUrl" : "documentationUrl",
-  "connectionSpecification" : {
-    "user" : {
-      "type" : "string"
-    }
-  },
-  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "advancedAuth" : {
-    "predicateValue" : "predicateValue",
-    "oauthConfigSpecification" : { },
-    "predicateKey" : [ "predicateKey", "predicateKey" ],
-    "authFlowType" : "oauth2.0"
-  },
-  "jobInfo" : {
-    "createdAt" : 0,
-    "connectorConfigurationUpdated" : false,
-    "configId" : "configId",
-    "endedAt" : 6,
-    "failureReason" : {
-      "retryable" : true,
-      "stacktrace" : "stacktrace",
-      "internalMessage" : "internalMessage",
-      "externalMessage" : "externalMessage",
-      "timestamp" : 1
-    },
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "logs" : {
-      "logLines" : [ "logLines", "logLines" ]
-    },
-    "succeeded" : true
-  }
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - SourceDefinitionSpecificationRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-

SourceOauth

-
-
- Up - 
post /v1/source_oauths/complete_oauth
-
Given a source def ID generate an access/refresh token etc. (completeSourceOAuth)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
CompleteSourceOauthRequest CompleteSourceOauthRequest (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- CompleteOAuthResponse - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "auth_payload" : {
-    "key" : ""
-  },
-  "request_error" : "request_error",
-  "request_succeeded" : true
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - CompleteOAuthResponse -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/source_oauths/get_consent_url
-
Given a source connector definition ID, return the URL to the consent screen where to redirect the user to. (getSourceOAuthConsent)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SourceOauthConsentRequest SourceOauthConsentRequest (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- OAuthConsentRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "consentUrl" : "consentUrl"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - OAuthConsentRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/source_oauths/revoke
-
Given a source definition ID and workspace ID revoke access/refresh token etc. (revokeSourceOAuthTokens)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
RevokeSourceOauthTokensRequest RevokeSourceOauthTokensRequest (required)
- -
Body Parameter —
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - -

400

- Exception occurred; see message for details. - KnownExceptionInfo -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -
-
-
-
- Up - 
post /v1/source_oauths/oauth_params/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 developer_token, client_id, and client_secret without the user having to know about these variables. (setInstancewideSourceOauthParams)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SetInstancewideSourceOauthParamsRequestBody SetInstancewideSourceOauthParamsRequestBody (required)
- -
Body Parameter —
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful - -

400

- Exception occurred; see message for details. - KnownExceptionInfo -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -
-
-

State

-
-
- Up - 
post /v1/state/create_or_update
-
Create or update the state for a connection. (createOrUpdateState)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectionStateCreateOrUpdate ConnectionStateCreateOrUpdate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- ConnectionState - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "globalState" : {
-    "streamStates" : [ {
-      "streamDescriptor" : {
-        "name" : "name",
-        "namespace" : "namespace"
-      }
-    }, {
-      "streamDescriptor" : {
-        "name" : "name",
-        "namespace" : "namespace"
-      }
-    } ]
-  },
-  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "streamState" : [ {
-    "streamDescriptor" : {
-      "name" : "name",
-      "namespace" : "namespace"
-    }
-  }, {
-    "streamDescriptor" : {
-      "name" : "name",
-      "namespace" : "namespace"
-    }
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - ConnectionState -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/state/get
-
Fetch the current state for a connection. (getState)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectionIdRequestBody ConnectionIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- ConnectionState - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "globalState" : {
-    "streamStates" : [ {
-      "streamDescriptor" : {
-        "name" : "name",
-        "namespace" : "namespace"
-      }
-    }, {
-      "streamDescriptor" : {
-        "name" : "name",
-        "namespace" : "namespace"
-      }
-    } ]
-  },
-  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "streamState" : [ {
-    "streamDescriptor" : {
-      "name" : "name",
-      "namespace" : "namespace"
-    }
-  }, {
-    "streamDescriptor" : {
-      "name" : "name",
-      "namespace" : "namespace"
-    }
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - ConnectionState -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-

StreamStatuses

-
-
- Up - 
post /v1/stream_statuses/create
-
Creates a stream status. (createStreamStatus)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
StreamStatusCreateRequestBody StreamStatusCreateRequestBody (optional)
- -
Body Parameter —
- -
- - - - -

Return type

-
- StreamStatusRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "attemptNumber" : 0,
-  "jobId" : 6,
-  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "streamNamespace" : "streamNamespace",
-  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "streamName" : "streamName",
-  "transitionedAt" : 1,
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

201

- Successfully created stream status. - StreamStatusRead -
-
-
-
- Up - 
post /v1/stream_statuses/list
-
Gets a list of stream statuses filtered by parameters (with AND semantics). (getStreamStatuses)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
StreamStatusListRequestBody StreamStatusListRequestBody (optional)
- -
Body Parameter —
- -
- - - - -

Return type

-
- StreamStatusReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "streamStatuses" : [ {
-    "attemptNumber" : 0,
-    "jobId" : 6,
-    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "streamNamespace" : "streamNamespace",
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "streamName" : "streamName",
-    "transitionedAt" : 1,
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "attemptNumber" : 0,
-    "jobId" : 6,
-    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "streamNamespace" : "streamNamespace",
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "streamName" : "streamName",
-    "transitionedAt" : 1,
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successfully queried stream statuses. - StreamStatusReadList -
-
-
-
- Up - 
post /v1/stream_statuses/update
-
Updates a stream status. (updateStreamStatus)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
StreamStatusUpdateRequestBody StreamStatusUpdateRequestBody (optional)
- -
Body Parameter —
- -
- - - - -

Return type

-
- StreamStatusRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "attemptNumber" : 0,
-  "jobId" : 6,
-  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "streamNamespace" : "streamNamespace",
-  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "streamName" : "streamName",
-  "transitionedAt" : 1,
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

201

- Successfully created stream status. - StreamStatusRead -

200

- Successfully updated stream status. - StreamStatusRead -
-
-

Streams

-
-
- Up - 
post /v1/stream_statuses/create
-
Creates a stream status. (createStreamStatus)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
StreamStatusCreateRequestBody StreamStatusCreateRequestBody (optional)
- -
Body Parameter —
- -
- - - - -

Return type

-
- StreamStatusRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "attemptNumber" : 0,
-  "jobId" : 6,
-  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "streamNamespace" : "streamNamespace",
-  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "streamName" : "streamName",
-  "transitionedAt" : 1,
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

201

- Successfully created stream status. - StreamStatusRead -
-
-
-
- Up - 
post /v1/stream_statuses/list
-
Gets a list of stream statuses filtered by parameters (with AND semantics). (getStreamStatuses)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
StreamStatusListRequestBody StreamStatusListRequestBody (optional)
- -
Body Parameter —
- -
- - - - -

Return type

-
- StreamStatusReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "streamStatuses" : [ {
-    "attemptNumber" : 0,
-    "jobId" : 6,
-    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "streamNamespace" : "streamNamespace",
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "streamName" : "streamName",
-    "transitionedAt" : 1,
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "attemptNumber" : 0,
-    "jobId" : 6,
-    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "streamNamespace" : "streamNamespace",
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "streamName" : "streamName",
-    "transitionedAt" : 1,
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successfully queried stream statuses. - StreamStatusReadList -
-
-
-
- Up - 
post /v1/stream_statuses/update
-
Updates a stream status. (updateStreamStatus)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
StreamStatusUpdateRequestBody StreamStatusUpdateRequestBody (optional)
- -
Body Parameter —
- -
- - - - -

Return type

-
- StreamStatusRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "attemptNumber" : 0,
-  "jobId" : 6,
-  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "streamNamespace" : "streamNamespace",
-  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "streamName" : "streamName",
-  "transitionedAt" : 1,
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

201

- Successfully created stream status. - StreamStatusRead -

200

- Successfully updated stream status. - StreamStatusRead -
-
-

WebBackend

-
-
- Up - 
post /v1/web_backend/state/get_type
-
Fetch the current state type for a connection. (getStateType)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectionIdRequestBody ConnectionIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- ConnectionStateType - -
- - - -

Example data

-
Content-Type: application/json
- 
null
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - ConnectionStateType -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/web_backend/check_updates
-
Returns a summary of source and destination definitions that could be updated. (webBackendCheckUpdates)
-
- - - - - - - -

Return type

-
- WebBackendCheckUpdatesRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "destinationDefinitions" : 0,
-  "sourceDefinitions" : 6
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - WebBackendCheckUpdatesRead -
-
-
-
- Up - 
post /v1/web_backend/connections/create
-
Create a connection (webBackendCreateConnection)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WebBackendConnectionCreate WebBackendConnectionCreate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- WebBackendConnectionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "latestSyncJobCreatedAt" : 0,
-  "prefix" : "prefix",
-  "destination" : {
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "destinationName" : "destinationName",
-    "name" : "name",
-    "icon" : "icon",
-    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  },
-  "isSyncing" : true,
-  "source" : {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "name" : "name",
-    "icon" : "icon",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceName" : "sourceName",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  },
-  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "catalogDiff" : {
-    "transforms" : [ {
-      "streamDescriptor" : {
-        "name" : "name",
-        "namespace" : "namespace"
-      },
-      "transformType" : "add_stream",
-      "updateStream" : [ {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      }, {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      } ]
-    }, {
-      "streamDescriptor" : {
-        "name" : "name",
-        "namespace" : "namespace"
-      },
-      "transformType" : "add_stream",
-      "updateStream" : [ {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      }, {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      } ]
-    } ]
-  },
-  "operations" : [ {
-    "name" : "name",
-    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "operatorConfiguration" : {
-      "webhook" : {
-        "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-        "dbtCloud" : {
-          "accountId" : 0,
-          "jobId" : 6
-        },
-        "executionUrl" : "executionUrl",
-        "executionBody" : "executionBody",
-        "webhookType" : "dbtCloud"
-      },
-      "normalization" : {
-        "option" : "basic"
-      },
-      "dbt" : {
-        "gitRepoBranch" : "gitRepoBranch",
-        "dockerImage" : "dockerImage",
-        "dbtArguments" : "dbtArguments",
-        "gitRepoUrl" : "gitRepoUrl"
-      }
-    },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "name" : "name",
-    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "operatorConfiguration" : {
-      "webhook" : {
-        "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-        "dbtCloud" : {
-          "accountId" : 0,
-          "jobId" : 6
-        },
-        "executionUrl" : "executionUrl",
-        "executionBody" : "executionBody",
-        "webhookType" : "dbtCloud"
-      },
-      "normalization" : {
-        "option" : "basic"
-      },
-      "dbt" : {
-        "gitRepoBranch" : "gitRepoBranch",
-        "dockerImage" : "dockerImage",
-        "dbtArguments" : "dbtArguments",
-        "gitRepoUrl" : "gitRepoUrl"
-      }
-    },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ],
-  "catalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "notifySchemaChanges" : true,
-  "notifySchemaChangesByEmail" : true,
-  "namespaceFormat" : "${SOURCE_NAMESPACE}",
-  "scheduleData" : {
-    "cron" : {
-      "cronExpression" : "cronExpression",
-      "cronTimeZone" : "cronTimeZone"
-    },
-    "basicSchedule" : {
-      "units" : 6,
-      "timeUnit" : "minutes"
-    }
-  },
-  "resourceRequirements" : {
-    "cpu_limit" : "cpu_limit",
-    "memory_request" : "memory_request",
-    "memory_limit" : "memory_limit",
-    "cpu_request" : "cpu_request"
-  },
-  "schedule" : {
-    "units" : 0,
-    "timeUnit" : "minutes"
-  },
-  "name" : "name",
-  "syncCatalog" : {
-    "streams" : [ {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "suggested" : true,
-        "fieldSelectionEnabled" : true,
-        "selectedFields" : [ {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        }, {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        } ],
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-      }
-    }, {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "suggested" : true,
-        "fieldSelectionEnabled" : true,
-        "selectedFields" : [ {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        }, {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        } ],
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-      }
-    } ]
-  },
-  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "operationIds" : [ null, null ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - WebBackendConnectionRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/web_backend/connections/get
-
Get a connection (webBackendGetConnection)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WebBackendConnectionRequestBody WebBackendConnectionRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- WebBackendConnectionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "latestSyncJobCreatedAt" : 0,
-  "prefix" : "prefix",
-  "destination" : {
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "destinationName" : "destinationName",
-    "name" : "name",
-    "icon" : "icon",
-    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  },
-  "isSyncing" : true,
-  "source" : {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "name" : "name",
-    "icon" : "icon",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceName" : "sourceName",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  },
-  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "catalogDiff" : {
-    "transforms" : [ {
-      "streamDescriptor" : {
-        "name" : "name",
-        "namespace" : "namespace"
-      },
-      "transformType" : "add_stream",
-      "updateStream" : [ {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      }, {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      } ]
-    }, {
-      "streamDescriptor" : {
-        "name" : "name",
-        "namespace" : "namespace"
-      },
-      "transformType" : "add_stream",
-      "updateStream" : [ {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      }, {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      } ]
-    } ]
-  },
-  "operations" : [ {
-    "name" : "name",
-    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "operatorConfiguration" : {
-      "webhook" : {
-        "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-        "dbtCloud" : {
-          "accountId" : 0,
-          "jobId" : 6
-        },
-        "executionUrl" : "executionUrl",
-        "executionBody" : "executionBody",
-        "webhookType" : "dbtCloud"
-      },
-      "normalization" : {
-        "option" : "basic"
-      },
-      "dbt" : {
-        "gitRepoBranch" : "gitRepoBranch",
-        "dockerImage" : "dockerImage",
-        "dbtArguments" : "dbtArguments",
-        "gitRepoUrl" : "gitRepoUrl"
-      }
-    },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "name" : "name",
-    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "operatorConfiguration" : {
-      "webhook" : {
-        "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-        "dbtCloud" : {
-          "accountId" : 0,
-          "jobId" : 6
-        },
-        "executionUrl" : "executionUrl",
-        "executionBody" : "executionBody",
-        "webhookType" : "dbtCloud"
-      },
-      "normalization" : {
-        "option" : "basic"
-      },
-      "dbt" : {
-        "gitRepoBranch" : "gitRepoBranch",
-        "dockerImage" : "dockerImage",
-        "dbtArguments" : "dbtArguments",
-        "gitRepoUrl" : "gitRepoUrl"
-      }
-    },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ],
-  "catalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "notifySchemaChanges" : true,
-  "notifySchemaChangesByEmail" : true,
-  "namespaceFormat" : "${SOURCE_NAMESPACE}",
-  "scheduleData" : {
-    "cron" : {
-      "cronExpression" : "cronExpression",
-      "cronTimeZone" : "cronTimeZone"
-    },
-    "basicSchedule" : {
-      "units" : 6,
-      "timeUnit" : "minutes"
-    }
-  },
-  "resourceRequirements" : {
-    "cpu_limit" : "cpu_limit",
-    "memory_request" : "memory_request",
-    "memory_limit" : "memory_limit",
-    "cpu_request" : "cpu_request"
-  },
-  "schedule" : {
-    "units" : 0,
-    "timeUnit" : "minutes"
-  },
-  "name" : "name",
-  "syncCatalog" : {
-    "streams" : [ {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "suggested" : true,
-        "fieldSelectionEnabled" : true,
-        "selectedFields" : [ {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        }, {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        } ],
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-      }
-    }, {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "suggested" : true,
-        "fieldSelectionEnabled" : true,
-        "selectedFields" : [ {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        }, {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        } ],
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-      }
-    } ]
-  },
-  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "operationIds" : [ null, null ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - WebBackendConnectionRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/web_backend/workspace/state
-
Returns the current state of a workspace (webBackendGetWorkspaceState)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WebBackendWorkspaceState WebBackendWorkspaceState (optional)
- -
Body Parameter —
- -
- - - - -

Return type

-
- WebBackendWorkspaceStateResult - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "hasDestinations" : true,
-  "hasConnections" : true,
-  "hasSources" : true
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - WebBackendWorkspaceStateResult -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/web_backend/connections/list
-
Returns all non-deleted connections for a workspace. (webBackendListConnectionsForWorkspace)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WebBackendConnectionListRequestBody WebBackendConnectionListRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- WebBackendConnectionReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "connections" : [ {
-    "latestSyncJobCreatedAt" : 0,
-    "name" : "name",
-    "destination" : {
-      "destinationName" : "destinationName",
-      "name" : "name",
-      "icon" : "icon",
-      "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-      "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-    },
-    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "isSyncing" : true,
-    "source" : {
-      "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-      "name" : "name",
-      "icon" : "icon",
-      "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-      "sourceName" : "sourceName"
-    },
-    "scheduleData" : {
-      "cron" : {
-        "cronExpression" : "cronExpression",
-        "cronTimeZone" : "cronTimeZone"
-      },
-      "basicSchedule" : {
-        "units" : 6,
-        "timeUnit" : "minutes"
-      }
-    }
-  }, {
-    "latestSyncJobCreatedAt" : 0,
-    "name" : "name",
-    "destination" : {
-      "destinationName" : "destinationName",
-      "name" : "name",
-      "icon" : "icon",
-      "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-      "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-    },
-    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "isSyncing" : true,
-    "source" : {
-      "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-      "name" : "name",
-      "icon" : "icon",
-      "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-      "sourceName" : "sourceName"
-    },
-    "scheduleData" : {
-      "cron" : {
-        "cronExpression" : "cronExpression",
-        "cronTimeZone" : "cronTimeZone"
-      },
-      "basicSchedule" : {
-        "units" : 6,
-        "timeUnit" : "minutes"
-      }
-    }
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - WebBackendConnectionReadList -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/web_backend/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. (webBackendListGeographies)
-
Returns all available geographies in which a data sync can run.
- - - - - - - -

Return type

-
- WebBackendGeographiesListResult - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "geographies" : [ null, null ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - WebBackendGeographiesListResult -
-
-
-
- Up - 
post /v1/web_backend/connections/update
-
Update a connection (webBackendUpdateConnection)
-
Apply a patch-style update to a connection. Only fields present on the update request body will be updated. -Any operations that lack an ID will be created. Then, the newly created operationId will be applied to the -connection along with the rest of the operationIds in the request body. -Apply a patch-style update to a connection. Only fields present on the update request body will be updated. -Note that if a catalog is present in the request body, the connection's entire catalog will be replaced -with the catalog from the request. This means that to modify a single stream, the entire new catalog -containing the updated stream needs to be sent.
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WebBackendConnectionUpdate WebBackendConnectionUpdate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- WebBackendConnectionRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "latestSyncJobCreatedAt" : 0,
-  "prefix" : "prefix",
-  "destination" : {
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "destinationName" : "destinationName",
-    "name" : "name",
-    "icon" : "icon",
-    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  },
-  "isSyncing" : true,
-  "source" : {
-    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "connectionConfiguration" : {
-      "user" : "charles"
-    },
-    "name" : "name",
-    "icon" : "icon",
-    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "sourceName" : "sourceName",
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  },
-  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "catalogDiff" : {
-    "transforms" : [ {
-      "streamDescriptor" : {
-        "name" : "name",
-        "namespace" : "namespace"
-      },
-      "transformType" : "add_stream",
-      "updateStream" : [ {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      }, {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      } ]
-    }, {
-      "streamDescriptor" : {
-        "name" : "name",
-        "namespace" : "namespace"
-      },
-      "transformType" : "add_stream",
-      "updateStream" : [ {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      }, {
-        "updateFieldSchema" : { },
-        "fieldName" : [ "fieldName", "fieldName" ],
-        "addField" : { },
-        "transformType" : "add_field",
-        "removeField" : { },
-        "breaking" : true
-      } ]
-    } ]
-  },
-  "operations" : [ {
-    "name" : "name",
-    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "operatorConfiguration" : {
-      "webhook" : {
-        "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-        "dbtCloud" : {
-          "accountId" : 0,
-          "jobId" : 6
-        },
-        "executionUrl" : "executionUrl",
-        "executionBody" : "executionBody",
-        "webhookType" : "dbtCloud"
-      },
-      "normalization" : {
-        "option" : "basic"
-      },
-      "dbt" : {
-        "gitRepoBranch" : "gitRepoBranch",
-        "dockerImage" : "dockerImage",
-        "dbtArguments" : "dbtArguments",
-        "gitRepoUrl" : "gitRepoUrl"
-      }
-    },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "name" : "name",
-    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "operatorConfiguration" : {
-      "webhook" : {
-        "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-        "dbtCloud" : {
-          "accountId" : 0,
-          "jobId" : 6
-        },
-        "executionUrl" : "executionUrl",
-        "executionBody" : "executionBody",
-        "webhookType" : "dbtCloud"
-      },
-      "normalization" : {
-        "option" : "basic"
-      },
-      "dbt" : {
-        "gitRepoBranch" : "gitRepoBranch",
-        "dockerImage" : "dockerImage",
-        "dbtArguments" : "dbtArguments",
-        "gitRepoUrl" : "gitRepoUrl"
-      }
-    },
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ],
-  "catalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "notifySchemaChanges" : true,
-  "notifySchemaChangesByEmail" : true,
-  "namespaceFormat" : "${SOURCE_NAMESPACE}",
-  "scheduleData" : {
-    "cron" : {
-      "cronExpression" : "cronExpression",
-      "cronTimeZone" : "cronTimeZone"
-    },
-    "basicSchedule" : {
-      "units" : 6,
-      "timeUnit" : "minutes"
-    }
-  },
-  "resourceRequirements" : {
-    "cpu_limit" : "cpu_limit",
-    "memory_request" : "memory_request",
-    "memory_limit" : "memory_limit",
-    "cpu_request" : "cpu_request"
-  },
-  "schedule" : {
-    "units" : 0,
-    "timeUnit" : "minutes"
-  },
-  "name" : "name",
-  "syncCatalog" : {
-    "streams" : [ {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "suggested" : true,
-        "fieldSelectionEnabled" : true,
-        "selectedFields" : [ {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        }, {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        } ],
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-      }
-    }, {
-      "stream" : {
-        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
-        "supportedSyncModes" : [ null, null ],
-        "sourceDefinedCursor" : true,
-        "name" : "name",
-        "namespace" : "namespace",
-        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
-      },
-      "config" : {
-        "aliasName" : "aliasName",
-        "suggested" : true,
-        "fieldSelectionEnabled" : true,
-        "selectedFields" : [ {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        }, {
-          "fieldPath" : [ "fieldPath", "fieldPath" ]
-        } ],
-        "cursorField" : [ "cursorField", "cursorField" ],
-        "selected" : true,
-        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
-      }
-    } ]
-  },
-  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "operationIds" : [ null, null ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - WebBackendConnectionRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-

Workspace

-
-
- Up - 
post /v1/workspaces/create
-
Creates a workspace (createWorkspace)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WorkspaceCreate WorkspaceCreate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- WorkspaceRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "news" : true,
-  "webhookConfigs" : [ {
-    "name" : "name",
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "name" : "name",
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ],
-  "notificationSettings" : {
-    "sendOnConnectionUpdateActionRequired" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSyncDisabledWarning" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSuccess" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnFailure" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnConnectionUpdate" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSyncDisabled" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    }
-  },
-  "displaySetupWizard" : true,
-  "initialSetupComplete" : true,
-  "anonymousDataCollection" : true,
-  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "name" : "name",
-  "firstCompletedSync" : true,
-  "feedbackDone" : true,
-  "email" : "email",
-  "slug" : "slug",
-  "securityUpdates" : true,
-  "notifications" : [ {
-    "slackConfiguration" : {
-      "webhook" : "webhook"
-    },
-    "sendOnSuccess" : false,
-    "sendOnFailure" : true,
-    "customerioConfiguration" : "{}"
-  }, {
-    "slackConfiguration" : {
-      "webhook" : "webhook"
-    },
-    "sendOnSuccess" : false,
-    "sendOnFailure" : true,
-    "customerioConfiguration" : "{}"
-  } ],
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - WorkspaceRead -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/workspaces/delete
-
Deletes a workspace (deleteWorkspace)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
- -
Body Parameter —
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

204

- The resource was deleted successfully. - -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/workspaces/get
-
Find workspace by ID (getWorkspace)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- WorkspaceRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "news" : true,
-  "webhookConfigs" : [ {
-    "name" : "name",
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "name" : "name",
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ],
-  "notificationSettings" : {
-    "sendOnConnectionUpdateActionRequired" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSyncDisabledWarning" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSuccess" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnFailure" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnConnectionUpdate" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSyncDisabled" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    }
-  },
-  "displaySetupWizard" : true,
-  "initialSetupComplete" : true,
-  "anonymousDataCollection" : true,
-  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "name" : "name",
-  "firstCompletedSync" : true,
-  "feedbackDone" : true,
-  "email" : "email",
-  "slug" : "slug",
-  "securityUpdates" : true,
-  "notifications" : [ {
-    "slackConfiguration" : {
-      "webhook" : "webhook"
-    },
-    "sendOnSuccess" : false,
-    "sendOnFailure" : true,
-    "customerioConfiguration" : "{}"
-  }, {
-    "slackConfiguration" : {
-      "webhook" : "webhook"
-    },
-    "sendOnSuccess" : false,
-    "sendOnFailure" : true,
-    "customerioConfiguration" : "{}"
-  } ],
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - WorkspaceRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/workspaces/get_by_connection_id
-
Find workspace by connection id (getWorkspaceByConnectionId)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
ConnectionIdRequestBody ConnectionIdRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- WorkspaceRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "news" : true,
-  "webhookConfigs" : [ {
-    "name" : "name",
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "name" : "name",
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ],
-  "notificationSettings" : {
-    "sendOnConnectionUpdateActionRequired" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSyncDisabledWarning" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSuccess" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnFailure" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnConnectionUpdate" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSyncDisabled" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    }
-  },
-  "displaySetupWizard" : true,
-  "initialSetupComplete" : true,
-  "anonymousDataCollection" : true,
-  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "name" : "name",
-  "firstCompletedSync" : true,
-  "feedbackDone" : true,
-  "email" : "email",
-  "slug" : "slug",
-  "securityUpdates" : true,
-  "notifications" : [ {
-    "slackConfiguration" : {
-      "webhook" : "webhook"
-    },
-    "sendOnSuccess" : false,
-    "sendOnFailure" : true,
-    "customerioConfiguration" : "{}"
-  }, {
-    "slackConfiguration" : {
-      "webhook" : "webhook"
-    },
-    "sendOnSuccess" : false,
-    "sendOnFailure" : true,
-    "customerioConfiguration" : "{}"
-  } ],
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - WorkspaceRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/workspaces/get_by_slug
-
Find workspace by slug (getWorkspaceBySlug)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
SlugRequestBody SlugRequestBody (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- WorkspaceRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "news" : true,
-  "webhookConfigs" : [ {
-    "name" : "name",
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "name" : "name",
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ],
-  "notificationSettings" : {
-    "sendOnConnectionUpdateActionRequired" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSyncDisabledWarning" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSuccess" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnFailure" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnConnectionUpdate" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSyncDisabled" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    }
-  },
-  "displaySetupWizard" : true,
-  "initialSetupComplete" : true,
-  "anonymousDataCollection" : true,
-  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "name" : "name",
-  "firstCompletedSync" : true,
-  "feedbackDone" : true,
-  "email" : "email",
-  "slug" : "slug",
-  "securityUpdates" : true,
-  "notifications" : [ {
-    "slackConfiguration" : {
-      "webhook" : "webhook"
-    },
-    "sendOnSuccess" : false,
-    "sendOnFailure" : true,
-    "customerioConfiguration" : "{}"
-  }, {
-    "slackConfiguration" : {
-      "webhook" : "webhook"
-    },
-    "sendOnSuccess" : false,
-    "sendOnFailure" : true,
-    "customerioConfiguration" : "{}"
-  } ],
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - WorkspaceRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/workspaces/list
-
List all workspaces registered in the current Airbyte deployment (listWorkspaces)
-
- - - - - - - -

Return type

-
- WorkspaceReadList - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "workspaces" : [ {
-    "news" : true,
-    "webhookConfigs" : [ {
-      "name" : "name",
-      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-    }, {
-      "name" : "name",
-      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-    } ],
-    "notificationSettings" : {
-      "sendOnConnectionUpdateActionRequired" : {
-        "slackConfiguration" : {
-          "webhook" : "webhook"
-        },
-        "customerioConfiguration" : "{}",
-        "notificationType" : [ null, null ]
-      },
-      "sendOnSyncDisabledWarning" : {
-        "slackConfiguration" : {
-          "webhook" : "webhook"
-        },
-        "customerioConfiguration" : "{}",
-        "notificationType" : [ null, null ]
-      },
-      "sendOnSuccess" : {
-        "slackConfiguration" : {
-          "webhook" : "webhook"
-        },
-        "customerioConfiguration" : "{}",
-        "notificationType" : [ null, null ]
-      },
-      "sendOnFailure" : {
-        "slackConfiguration" : {
-          "webhook" : "webhook"
-        },
-        "customerioConfiguration" : "{}",
-        "notificationType" : [ null, null ]
-      },
-      "sendOnConnectionUpdate" : {
-        "slackConfiguration" : {
-          "webhook" : "webhook"
-        },
-        "customerioConfiguration" : "{}",
-        "notificationType" : [ null, null ]
-      },
-      "sendOnSyncDisabled" : {
-        "slackConfiguration" : {
-          "webhook" : "webhook"
-        },
-        "customerioConfiguration" : "{}",
-        "notificationType" : [ null, null ]
-      }
-    },
-    "displaySetupWizard" : true,
-    "initialSetupComplete" : true,
-    "anonymousDataCollection" : true,
-    "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "name" : "name",
-    "firstCompletedSync" : true,
-    "feedbackDone" : true,
-    "email" : "email",
-    "slug" : "slug",
-    "securityUpdates" : true,
-    "notifications" : [ {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "sendOnSuccess" : false,
-      "sendOnFailure" : true,
-      "customerioConfiguration" : "{}"
-    }, {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "sendOnSuccess" : false,
-      "sendOnFailure" : true,
-      "customerioConfiguration" : "{}"
-    } ],
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "news" : true,
-    "webhookConfigs" : [ {
-      "name" : "name",
-      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-    }, {
-      "name" : "name",
-      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-    } ],
-    "notificationSettings" : {
-      "sendOnConnectionUpdateActionRequired" : {
-        "slackConfiguration" : {
-          "webhook" : "webhook"
-        },
-        "customerioConfiguration" : "{}",
-        "notificationType" : [ null, null ]
-      },
-      "sendOnSyncDisabledWarning" : {
-        "slackConfiguration" : {
-          "webhook" : "webhook"
-        },
-        "customerioConfiguration" : "{}",
-        "notificationType" : [ null, null ]
-      },
-      "sendOnSuccess" : {
-        "slackConfiguration" : {
-          "webhook" : "webhook"
-        },
-        "customerioConfiguration" : "{}",
-        "notificationType" : [ null, null ]
-      },
-      "sendOnFailure" : {
-        "slackConfiguration" : {
-          "webhook" : "webhook"
-        },
-        "customerioConfiguration" : "{}",
-        "notificationType" : [ null, null ]
-      },
-      "sendOnConnectionUpdate" : {
-        "slackConfiguration" : {
-          "webhook" : "webhook"
-        },
-        "customerioConfiguration" : "{}",
-        "notificationType" : [ null, null ]
-      },
-      "sendOnSyncDisabled" : {
-        "slackConfiguration" : {
-          "webhook" : "webhook"
-        },
-        "customerioConfiguration" : "{}",
-        "notificationType" : [ null, null ]
-      }
-    },
-    "displaySetupWizard" : true,
-    "initialSetupComplete" : true,
-    "anonymousDataCollection" : true,
-    "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-    "name" : "name",
-    "firstCompletedSync" : true,
-    "feedbackDone" : true,
-    "email" : "email",
-    "slug" : "slug",
-    "securityUpdates" : true,
-    "notifications" : [ {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "sendOnSuccess" : false,
-      "sendOnFailure" : true,
-      "customerioConfiguration" : "{}"
-    }, {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "sendOnSuccess" : false,
-      "sendOnFailure" : true,
-      "customerioConfiguration" : "{}"
-    } ],
-    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ]
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - WorkspaceReadList -
-
-
-
- Up - 
post /v1/workspaces/update
-
Update workspace state (updateWorkspace)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WorkspaceUpdate WorkspaceUpdate (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- WorkspaceRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "news" : true,
-  "webhookConfigs" : [ {
-    "name" : "name",
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "name" : "name",
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ],
-  "notificationSettings" : {
-    "sendOnConnectionUpdateActionRequired" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSyncDisabledWarning" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSuccess" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnFailure" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnConnectionUpdate" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSyncDisabled" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    }
-  },
-  "displaySetupWizard" : true,
-  "initialSetupComplete" : true,
-  "anonymousDataCollection" : true,
-  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "name" : "name",
-  "firstCompletedSync" : true,
-  "feedbackDone" : true,
-  "email" : "email",
-  "slug" : "slug",
-  "securityUpdates" : true,
-  "notifications" : [ {
-    "slackConfiguration" : {
-      "webhook" : "webhook"
-    },
-    "sendOnSuccess" : false,
-    "sendOnFailure" : true,
-    "customerioConfiguration" : "{}"
-  }, {
-    "slackConfiguration" : {
-      "webhook" : "webhook"
-    },
-    "sendOnSuccess" : false,
-    "sendOnFailure" : true,
-    "customerioConfiguration" : "{}"
-  } ],
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - WorkspaceRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
-
-
- Up - 
post /v1/workspaces/tag_feedback_status_as_done
-
Update workspace feedback state (updateWorkspaceFeedback)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WorkspaceGiveFeedback WorkspaceGiveFeedback (required)
- -
Body Parameter —
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

204

- The feedback state has been properly updated - -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -
-
-
-
- Up - 
post /v1/workspaces/update_name
-
Update workspace name (updateWorkspaceName)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
WorkspaceUpdateName WorkspaceUpdateName (required)
- -
Body Parameter —
- -
- - - - -

Return type

-
- WorkspaceRead - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "news" : true,
-  "webhookConfigs" : [ {
-    "name" : "name",
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  }, {
-    "name" : "name",
-    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-  } ],
-  "notificationSettings" : {
-    "sendOnConnectionUpdateActionRequired" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSyncDisabledWarning" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSuccess" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnFailure" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnConnectionUpdate" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    },
-    "sendOnSyncDisabled" : {
-      "slackConfiguration" : {
-        "webhook" : "webhook"
-      },
-      "customerioConfiguration" : "{}",
-      "notificationType" : [ null, null ]
-    }
-  },
-  "displaySetupWizard" : true,
-  "initialSetupComplete" : true,
-  "anonymousDataCollection" : true,
-  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
-  "name" : "name",
-  "firstCompletedSync" : true,
-  "feedbackDone" : true,
-  "email" : "email",
-  "slug" : "slug",
-  "securityUpdates" : true,
-  "notifications" : [ {
-    "slackConfiguration" : {
-      "webhook" : "webhook"
-    },
-    "sendOnSuccess" : false,
-    "sendOnFailure" : true,
-    "customerioConfiguration" : "{}"
-  }, {
-    "slackConfiguration" : {
-      "webhook" : "webhook"
-    },
-    "sendOnSuccess" : false,
-    "sendOnFailure" : true,
-    "customerioConfiguration" : "{}"
-  } ],
-  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful operation - WorkspaceRead -

404

- Object with given id was not found. - NotFoundKnownExceptionInfo -

422

- Input failed validation - InvalidInputExceptionInfo -
-
- -

Models

- [ Jump to Methods ] - -

Table of Contents

-
    -
  1. ActorCatalogWithUpdatedAt -
    2. -
  2. ActorDefinitionRequestBody -
    3. -
  3. ActorDefinitionResourceRequirements -
    4. -
  4. ActorType -
    5. -
  5. AdvancedAuth -
    6. -
  6. AirbyteCatalog -
    7. -
  7. AirbyteStream -
    8. -
  8. AirbyteStreamAndConfiguration -
    9. -
  9. AirbyteStreamConfiguration -
    10. -
  10. AttemptFailureSummary -
    11. -
  11. AttemptInfoRead -
    12. -
  12. AttemptNormalizationStatusRead -
    13. -
  13. AttemptNormalizationStatusReadList -
    14. -
  14. AttemptRead -
    15. -
  15. AttemptStats -
    16. -
  16. AttemptStatus -
    17. -
  17. AttemptStreamStats -
    18. -
  18. AttemptSyncConfig -
    19. -
  19. CatalogDiff -
    20. -
  20. CheckConnectionRead -
    21. -
  21. CheckOperationRead -
    22. -
  22. CompleteDestinationOAuthRequest -
    23. -
  23. CompleteOAuthResponse -
    24. -
  24. CompleteSourceOauthRequest -
    25. -
  25. ConnectionCreate -
    26. -
  26. ConnectionIdRequestBody -
    27. -
  27. ConnectionRead -
    28. -
  28. ConnectionReadList -
    29. -
  29. ConnectionSchedule -
    30. -
  30. ConnectionScheduleData -
    31. -
  31. ConnectionScheduleData_basicSchedule -
    32. -
  32. ConnectionScheduleData_cron -
    33. -
  33. ConnectionScheduleType -
    34. -
  34. ConnectionSearch -
    35. -
  35. ConnectionState -
    36. -
  36. ConnectionStateCreateOrUpdate -
    37. -
  37. ConnectionStateType -
    38. -
  38. ConnectionStatus -
    39. -
  39. ConnectionStream -
    40. -
  40. ConnectionStreamRequestBody -
    41. -
  41. ConnectionUpdate -
    42. -
  42. ConnectorBuilderProjectDetails -
    43. -
  43. ConnectorBuilderProjectDetailsRead -
    44. -
  44. ConnectorBuilderProjectIdWithWorkspaceId -
    45. -
  45. ConnectorBuilderProjectRead -
    46. -
  46. ConnectorBuilderProjectReadList -
    47. -
  47. ConnectorBuilderProjectWithWorkspaceId -
    48. -
  48. ConnectorBuilderPublishRequestBody -
    49. -
  49. CustomDestinationDefinitionCreate -
    50. -
  50. CustomSourceDefinitionCreate -
    51. -
  51. DataType -
    52. -
  52. DbMigrationExecutionRead -
    53. -
  53. DbMigrationRead -
    54. -
  54. DbMigrationReadList -
    55. -
  55. DbMigrationRequestBody -
    56. -
  56. DbMigrationState -
    57. -
  57. DeclarativeManifestRead -
    58. -
  58. DeclarativeManifestVersionRead -
    59. -
  59. DeclarativeManifestsReadList -
    60. -
  60. DeclarativeSourceDefinitionCreateManifestRequestBody -
    61. -
  61. DeclarativeSourceManifest -
    62. -
  62. DestinationCloneConfiguration -
    63. -
  63. DestinationCloneRequestBody -
    64. -
  64. DestinationCoreConfig -
    65. -
  65. DestinationCreate -
    66. -
  66. DestinationDefinitionCreate -
    67. -
  67. DestinationDefinitionIdRequestBody -
    68. -
  68. DestinationDefinitionIdWithWorkspaceId -
    69. -
  69. DestinationDefinitionRead -
    70. -
  70. DestinationDefinitionReadList -
    71. -
  71. DestinationDefinitionSpecificationRead -
    72. -
  72. DestinationDefinitionUpdate -
    73. -
  73. DestinationIdRequestBody -
    74. -
  74. DestinationOauthConsentRequest -
    75. -
  75. DestinationRead -
    76. -
  76. DestinationReadList -
    77. -
  77. DestinationSearch -
    78. -
  78. DestinationSnippetRead -
    79. -
  79. DestinationSyncMode -
    80. -
  80. DestinationUpdate -
    81. -
  81. DiscoverCatalogResult -
    82. -
  82. ExistingConnectorBuilderProjectWithWorkspaceId -
    83. -
  83. FailureOrigin -
    84. -
  84. FailureReason -
    85. -
  85. FailureType -
    86. -
  86. FieldAdd -
    87. -
  87. FieldRemove -
    88. -
  88. FieldSchemaUpdate -
    89. -
  89. FieldTransform -
    90. -
  90. Geography -
    91. -
  91. GlobalState -
    92. -
  92. HealthCheckRead -
    93. -
  93. ImportRead -
    94. -
  94. ImportRequestBody -
    95. -
  95. InternalOperationResult -
    96. -
  96. InvalidInputExceptionInfo -
    97. -
  97. InvalidInputProperty -
    98. -
  98. JobConfigType -
    99. -
  99. JobDebugInfoRead -
    100. -
  100. JobDebugRead -
    101. -
  101. JobIdRequestBody -
    102. -
  102. JobInfoLightRead -
    103. -
  103. JobInfoRead -
    104. -
  104. JobListRequestBody -
    105. -
  105. JobOptionalRead -
    106. -
  106. JobRead -
    107. -
  107. JobReadList -
    108. -
  108. JobStatus -
    109. -
  109. JobType -
    110. -
  110. JobTypeResourceLimit -
    111. -
  111. JobWithAttemptsRead -
    112. -
  112. KnownExceptionInfo -
    113. -
  113. ListConnectionsForWorkspacesRequestBody -
    114. -
  114. ListDeclarativeManifestsRequestBody -
    115. -
  115. ListResourcesForWorkspacesRequestBody -
    116. -
  116. LogRead -
    117. -
  117. LogType -
    118. -
  118. LogsRequestBody -
    119. -
  119. NamespaceDefinitionType -
    120. -
  120. NonBreakingChangesPreference -
    121. -
  121. NormalizationDestinationDefinitionConfig -
    122. -
  122. NotFoundKnownExceptionInfo -
    123. -
  123. Notification -
    124. -
  124. NotificationItem -
    125. -
  125. NotificationRead -
    126. -
  126. NotificationSettings -
    127. -
  127. NotificationType -
    128. -
  128. OAuthConfigSpecification -
    129. -
  129. OAuthConsentRead -
    130. -
  130. OperationCreate -
    131. -
  131. OperationIdRequestBody -
    132. -
  132. OperationRead -
    133. -
  133. OperationReadList -
    134. -
  134. OperationUpdate -
    135. -
  135. OperatorConfiguration -
    136. -
  136. OperatorDbt -
    137. -
  137. OperatorNormalization -
    138. -
  138. OperatorType -
    139. -
  139. OperatorWebhook -
    140. -
  140. OperatorWebhook_dbtCloud -
    141. -
  141. Pagination -
    142. -
  142. PartialDestinationUpdate -
    143. -
  143. PartialSourceUpdate -
    144. -
  144. PrivateDestinationDefinitionRead -
    145. -
  145. PrivateDestinationDefinitionReadList -
    146. -
  146. PrivateSourceDefinitionRead -
    147. -
  147. PrivateSourceDefinitionReadList -
    148. -
  148. ReleaseStage -
    149. -
  149. ResetConfig -
    150. -
  150. ResourceRequirements -
    151. -
  151. RevokeSourceOauthTokensRequest -
    152. -
  152. SaveAttemptSyncConfigRequestBody -
    153. -
  153. SaveStatsRequestBody -
    154. -
  154. SchemaChange -
    155. -
  155. SelectedFieldInfo -
    156. -
  156. SetInstancewideDestinationOauthParamsRequestBody -
    157. -
  157. SetInstancewideSourceOauthParamsRequestBody -
    158. -
  158. SetWorkflowInAttemptRequestBody -
    159. -
  159. SlackNotificationConfiguration -
    160. -
  160. SlugRequestBody -
    161. -
  161. SourceAutoPropagateChange -
    162. -
  162. SourceCloneConfiguration -
    163. -
  163. SourceCloneRequestBody -
    164. -
  164. SourceCoreConfig -
    165. -
  165. SourceCreate -
    166. -
  166. SourceDefinitionCreate -
    167. -
  167. SourceDefinitionIdBody -
    168. -
  168. SourceDefinitionIdRequestBody -
    169. -
  169. SourceDefinitionIdWithWorkspaceId -
    170. -
  170. SourceDefinitionRead -
    171. -
  171. SourceDefinitionReadList -
    172. -
  172. SourceDefinitionSpecificationRead -
    173. -
  173. SourceDefinitionUpdate -
    174. -
  174. SourceDiscoverSchemaRead -
    175. -
  175. SourceDiscoverSchemaRequestBody -
    176. -
  176. SourceDiscoverSchemaWriteRequestBody -
    177. -
  177. SourceIdRequestBody -
    178. -
  178. SourceOauthConsentRequest -
    179. -
  179. SourceRead -
    180. -
  180. SourceReadList -
    181. -
  181. SourceSearch -
    182. -
  182. SourceSnippetRead -
    183. -
  183. SourceUpdate -
    184. -
  184. StreamDescriptor -
    185. -
  185. StreamState -
    186. -
  186. StreamStatusCreateRequestBody -
    187. -
  187. StreamStatusIncompleteRunCause -
    188. -
  188. StreamStatusJobType -
    189. -
  189. StreamStatusListRequestBody -
    190. -
  190. StreamStatusRead -
    191. -
  191. StreamStatusReadList -
    192. -
  192. StreamStatusRunState -
    193. -
  193. StreamStatusUpdateRequestBody -
    194. -
  194. StreamTransform -
    195. -
  195. SyncMode -
    196. -
  196. SynchronousJobRead -
    197. -
  197. UpdateActiveManifestRequestBody -
    198. -
  198. UploadRead -
    199. -
  199. WebBackendCheckUpdatesRead -
    200. -
  200. WebBackendConnectionCreate -
    201. -
  201. WebBackendConnectionListItem -
    202. -
  202. WebBackendConnectionListRequestBody -
    203. -
  203. WebBackendConnectionRead -
    204. -
  204. WebBackendConnectionReadList -
    205. -
  205. WebBackendConnectionRequestBody -
    206. -
  206. WebBackendConnectionUpdate -
    207. -
  207. WebBackendGeographiesListResult -
    208. -
  208. WebBackendOperationCreateOrUpdate -
    209. -
  209. WebBackendWorkspaceState -
    210. -
  210. WebBackendWorkspaceStateResult -
    211. -
  211. WebhookConfigRead -
    212. -
  212. WebhookConfigWrite -
    213. -
  213. WorkflowStateRead -
    214. -
  214. WorkspaceCreate -
    215. -
  215. WorkspaceGiveFeedback -
    216. -
  216. WorkspaceIdRequestBody -
    217. -
  217. WorkspaceOverrideOauthParamsRequestBody -
    218. -
  218. WorkspaceRead -
    219. -
  219. WorkspaceReadList -
    220. -
  220. WorkspaceUpdate -
    221. -
  221. WorkspaceUpdateName -
    222. -
- -
-

ActorCatalogWithUpdatedAt - Up

-
A source actor catalog with the timestamp it was mostly recently updated
-
-
updatedAt (optional)
Long format: int64
-
catalog (optional)
Object
-
-
-
-

ActorDefinitionRequestBody - Up

-
-
-
actorDefinitionId
UUID format: uuid
-
actorType
ActorType
-
-
-
-

ActorDefinitionResourceRequirements - Up

-
actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
-
-
default (optional)
ResourceRequirements
-
jobSpecific (optional)
array[JobTypeResourceLimit]
-
-
-
-

ActorType - Up

-
-
-
-
-
-

AdvancedAuth - Up

-
-
-
authFlowType (optional)
String
-
Enum:
-
oauth2.0
oauth1.0
-
predicateKey (optional)
array[String] Json Path to a field in the connectorSpecification that should exist for the advanced auth to be applicable.
-
predicateValue (optional)
String Value of the predicate_key fields for the advanced auth to be applicable.
-
oauthConfigSpecification (optional)
OAuthConfigSpecification
-
-
-
-

AirbyteCatalog - Up

-
describes the available schema (catalog).
-
-
streams
array[AirbyteStreamAndConfiguration]
-
-
-
-

AirbyteStream - Up

-
the immutable schema defined by the source
-
-
name
String Stream's name.
-
jsonSchema (optional)
StreamJsonSchema
-
supportedSyncModes (optional)
array[SyncMode]
-
sourceDefinedCursor (optional)
Boolean If the source defines the cursor field, then any other cursor field inputs will be ignored. If it does not, either the user_provided one is used, or the default one is used as a backup.
-
defaultCursorField (optional)
array[String] Path to the field that will be used to determine if a record is new or modified since the last sync. If not provided by the source, the end user will have to specify the comparable themselves.
-
sourceDefinedPrimaryKey (optional)
array[array[String]] If the source defines the primary key, paths to the fields that will be used as a primary key. If not provided by the source, the end user will have to specify the primary key themselves.
-
namespace (optional)
String Optional Source-defined namespace. Airbyte streams from the same sources should have the same namespace. Currently only used by JDBC destinations to determine what schema to write to.
-
-
-
-

AirbyteStreamAndConfiguration - Up

-
each stream is split in two parts; the immutable schema from source and mutable configuration for destination
-
-
stream (optional)
AirbyteStream
-
config (optional)
AirbyteStreamConfiguration
-
-
-
-

AirbyteStreamConfiguration - Up

-
the mutable part of the stream to configure the destination
-
-
syncMode
SyncMode
-
cursorField (optional)
array[String] Path to the field that will be used to determine if a record is new or modified since the last sync. This field is REQUIRED if sync_mode is incremental. Otherwise it is ignored.
-
destinationSyncMode
DestinationSyncMode
-
primaryKey (optional)
array[array[String]] Paths to the fields that will be used as primary key. This field is REQUIRED if destination_sync_mode is *_dedup. Otherwise it is ignored.
-
aliasName (optional)
String Alias name to the stream to be used in the destination
-
selected (optional)
Boolean If this is true, the stream is selected with all of its properties. For new connections, this considers if the stream is suggested or not
-
suggested (optional)
Boolean Does the connector suggest that this stream be enabled by default?
-
fieldSelectionEnabled (optional)
Boolean Whether field selection should be enabled. If this is true, only the properties in selectedFields will be included.
-
selectedFields (optional)
array[SelectedFieldInfo] Paths to the fields that will be included in the configured catalog. This must be set if fieldSelectedEnabled is set. An empty list indicates that no properties will be included.
-
-
-
-

AttemptFailureSummary - Up

-
-
-
failures
array[FailureReason]
-
partialSuccess (optional)
Boolean True if the number of committed records for this attempt was greater than 0. False if 0 records were committed. If not set, the number of committed records is unknown.
-
-
-
-

AttemptInfoRead - Up

-
-
-
attempt
AttemptRead
-
logs
LogRead
-
-
-
-

AttemptNormalizationStatusRead - Up

-
-
-
attemptNumber (optional)
Integer format: int32
-
hasRecordsCommitted (optional)
Boolean
-
recordsCommitted (optional)
Long format: int64
-
hasNormalizationFailed (optional)
Boolean
-
-
-
-

AttemptNormalizationStatusReadList - Up

-
-
-
attemptNormalizationStatuses (optional)
array[AttemptNormalizationStatusRead]
-
-
-
-

AttemptRead - Up

-
-
-
id
Long format: int64
-
status
AttemptStatus
-
createdAt
Long format: int64
-
updatedAt
Long format: int64
-
endedAt (optional)
Long format: int64
-
bytesSynced (optional)
Long format: int64
-
recordsSynced (optional)
Long format: int64
-
totalStats (optional)
AttemptStats
-
streamStats (optional)
array[AttemptStreamStats]
-
failureSummary (optional)
AttemptFailureSummary
-
-
-
-

AttemptStats - Up

-
-
-
recordsEmitted (optional)
Long format: int64
-
bytesEmitted (optional)
Long format: int64
-
stateMessagesEmitted (optional)
Long format: int64
-
bytesCommitted (optional)
Long format: int64
-
recordsCommitted (optional)
Long format: int64
-
estimatedRecords (optional)
Long format: int64
-
estimatedBytes (optional)
Long format: int64
-
-
-
-

AttemptStatus - Up

-
-
-
-
-
-

AttemptStreamStats - Up

-
-
-
streamName
String
-
streamNamespace (optional)
String
-
stats
AttemptStats
-
-
-
-

AttemptSyncConfig - Up

-
-
-
sourceConfiguration
SourceConfiguration
-
destinationConfiguration
DestinationConfiguration
-
state (optional)
ConnectionState
-
-
-
-

CatalogDiff - Up

-
Describes the difference between two Airbyte catalogs.
-
-
transforms
array[StreamTransform] list of stream transformations. order does not matter.
-
-
-
-

CheckConnectionRead - Up

-
-
-
status (optional)
String
-
Enum:
-
succeeded
failed
-
message (optional)
String
-
jobInfo
SynchronousJobRead
-
-
-
-

CheckOperationRead - Up

-
-
-
status
String
-
Enum:
-
succeeded
failed
-
message (optional)
String
-
-
-
-

CompleteDestinationOAuthRequest - Up

-
-
-
destinationDefinitionId
UUID format: uuid
-
workspaceId
UUID format: uuid
-
redirectUrl (optional)
String When completing OAuth flow to gain an access token, some API sometimes requires to verify that the app re-send the redirectUrl that was used when consent was given.
-
queryParams (optional)
map[String, oas_any_type_not_mapped] The query parameters present in the redirect URL after a user granted consent e.g auth code
-
oAuthInputConfiguration (optional)
OAuthConfiguration
-
destinationId (optional)
UUID format: uuid
-
-
-
-

CompleteOAuthResponse - Up

-
-
-
request_succeeded
Boolean
-
request_error (optional)
String
-
auth_payload
map[String, oas_any_type_not_mapped]
-
-
-
-

CompleteSourceOauthRequest - Up

-
-
-
sourceDefinitionId
UUID format: uuid
-
workspaceId
UUID format: uuid
-
redirectUrl (optional)
String When completing OAuth flow to gain an access token, some API sometimes requires to verify that the app re-send the redirectUrl that was used when consent was given.
-
queryParams (optional)
map[String, oas_any_type_not_mapped] The query parameters present in the redirect URL after a user granted consent e.g auth code
-
oAuthInputConfiguration (optional)
OAuthConfiguration
-
returnSecretCoordinate (optional)
Boolean If set to true, returns a secret coordinate which references the stored tokens. By default, returns raw tokens.
-
sourceId (optional)
UUID format: uuid
-
-
-
-

ConnectionCreate - Up

-
-
-
name (optional)
String Optional name of the connection
-
namespaceDefinition (optional)
NamespaceDefinitionType
-
namespaceFormat (optional)
String Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
-
prefix (optional)
String Prefix that will be prepended to the name of each stream when it is written to the destination.
-
sourceId
UUID format: uuid
-
destinationId
UUID format: uuid
-
operationIds (optional)
array[UUID] format: uuid
-
syncCatalog (optional)
AirbyteCatalog
-
schedule (optional)
ConnectionSchedule
-
scheduleType (optional)
ConnectionScheduleType
-
scheduleData (optional)
ConnectionScheduleData
-
status
ConnectionStatus
-
resourceRequirements (optional)
ResourceRequirements
-
sourceCatalogId (optional)
UUID format: uuid
-
geography (optional)
Geography
-
notifySchemaChanges (optional)
Boolean
-
notifySchemaChangesByEmail (optional)
Boolean
-
nonBreakingChangesPreference (optional)
NonBreakingChangesPreference
-
-
-
-

ConnectionIdRequestBody - Up

-
-
-
connectionId
UUID format: uuid
-
-
-
-

ConnectionRead - Up

-
-
-
connectionId
UUID format: uuid
-
name
String
-
namespaceDefinition (optional)
NamespaceDefinitionType
-
namespaceFormat (optional)
String Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
-
prefix (optional)
String Prefix that will be prepended to the name of each stream when it is written to the destination.
-
sourceId
UUID format: uuid
-
destinationId
UUID format: uuid
-
operationIds (optional)
array[UUID] format: uuid
-
syncCatalog
AirbyteCatalog
-
schedule (optional)
ConnectionSchedule
-
scheduleType (optional)
ConnectionScheduleType
-
scheduleData (optional)
ConnectionScheduleData
-
status
ConnectionStatus
-
resourceRequirements (optional)
ResourceRequirements
-
sourceCatalogId (optional)
UUID format: uuid
-
geography (optional)
Geography
-
breakingChange
Boolean
-
notifySchemaChanges (optional)
Boolean
-
notifySchemaChangesByEmail (optional)
Boolean
-
nonBreakingChangesPreference (optional)
NonBreakingChangesPreference
-
workspaceId (optional)
UUID format: uuid
-
-
-
-

ConnectionReadList - Up

-
-
-
connections
array[ConnectionRead]
-
-
-
-

ConnectionSchedule - Up

-
if null, then no schedule is set.
-
-
units
Long format: int64
-
timeUnit
String
-
Enum:
-
minutes
hours
days
weeks
months
-
-
-
-

ConnectionScheduleData - Up

-
schedule for when the the connection should run, per the schedule type
-
-
basicSchedule (optional)
ConnectionScheduleData_basicSchedule
-
cron (optional)
ConnectionScheduleData_cron
-
-
-
-

ConnectionScheduleData_basicSchedule - Up

-
-
-
timeUnit
String
-
Enum:
-
minutes
hours
days
weeks
months
-
units
Long format: int64
-
-
-
-

ConnectionScheduleData_cron - Up

-
-
-
cronExpression
String
-
cronTimeZone
String
-
-
-
-

ConnectionScheduleType - Up

-
determine how the schedule data should be interpreted
-
-
-
-
-

ConnectionSearch - Up

-
-
-
connectionId (optional)
UUID format: uuid
-
name (optional)
String
-
namespaceDefinition (optional)
NamespaceDefinitionType
-
namespaceFormat (optional)
String Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
-
prefix (optional)
String Prefix that will be prepended to the name of each stream when it is written to the destination.
-
sourceId (optional)
UUID format: uuid
-
destinationId (optional)
UUID format: uuid
-
schedule (optional)
ConnectionSchedule
-
scheduleType (optional)
ConnectionScheduleType
-
scheduleData (optional)
ConnectionScheduleData
-
status (optional)
ConnectionStatus
-
source (optional)
SourceSearch
-
destination (optional)
DestinationSearch
-
-
-
-

ConnectionState - Up

-
Contains the state for a connection. The stateType field identifies what type of state it is. Only the field corresponding to that type will be set, the rest will be null. If stateType=not_set, then none of the fields will be set.
-
-
stateType
ConnectionStateType
-
connectionId
UUID format: uuid
-
state (optional)
StateBlob
-
streamState (optional)
array[StreamState]
-
globalState (optional)
GlobalState
-
-
-
-

ConnectionStateCreateOrUpdate - Up

-
-
-
connectionId
UUID format: uuid
-
connectionState
ConnectionState
-
-
-
-

ConnectionStateType - Up

-
-
-
-
-
-

ConnectionStatus - Up

-
Active means that data is flowing through the connection. Inactive means it is not. Deprecated means the connection is off and cannot be re-activated. the schema field describes the elements of the schema that will be synced.
-
-
-
-
-

ConnectionStream - Up

-
-
-
streamName
String
-
streamNamespace
String
-
-
-
-

ConnectionStreamRequestBody - Up

-
-
-
connectionId
UUID format: uuid
-
streams
array[ConnectionStream]
-
-
-
-

ConnectionUpdate - Up

-
Used to apply a patch-style update to a connection, which means that null properties remain unchanged
-
-
connectionId
UUID format: uuid
-
namespaceDefinition (optional)
NamespaceDefinitionType
-
namespaceFormat (optional)
String Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
-
name (optional)
String Name that will be set to this connection
-
prefix (optional)
String Prefix that will be prepended to the name of each stream when it is written to the destination.
-
operationIds (optional)
array[UUID] format: uuid
-
syncCatalog (optional)
AirbyteCatalog
-
schedule (optional)
ConnectionSchedule
-
scheduleType (optional)
ConnectionScheduleType
-
scheduleData (optional)
ConnectionScheduleData
-
status (optional)
ConnectionStatus
-
resourceRequirements (optional)
ResourceRequirements
-
sourceCatalogId (optional)
UUID format: uuid
-
geography (optional)
Geography
-
notifySchemaChanges (optional)
Boolean
-
notifySchemaChangesByEmail (optional)
Boolean
-
nonBreakingChangesPreference (optional)
NonBreakingChangesPreference
-
breakingChange (optional)
Boolean
-
-
-
-

ConnectorBuilderProjectDetails - Up

-
-
-
name
String
-
draftManifest (optional)
Object Low code CDK manifest JSON object
-
-
-
-

ConnectorBuilderProjectDetailsRead - Up

-
-
-
name
String
-
builderProjectId
UUID format: uuid
-
sourceDefinitionId (optional)
UUID format: uuid
-
activeDeclarativeManifestVersion (optional)
Long format: int64
-
hasDraft
Boolean
-
-
-
-

ConnectorBuilderProjectIdWithWorkspaceId - Up

-
-
-
workspaceId
UUID format: uuid
-
builderProjectId
UUID format: uuid
-
version (optional)
Long format: int64
-
-
-
-

ConnectorBuilderProjectRead - Up

-
-
-
builderProject
ConnectorBuilderProjectDetailsRead
-
declarativeManifest (optional)
DeclarativeManifestRead
-
-
-
-

ConnectorBuilderProjectReadList - Up

-
-
-
projects
array[ConnectorBuilderProjectDetailsRead]
-
-
-
-

ConnectorBuilderProjectWithWorkspaceId - Up

-
-
-
workspaceId
UUID format: uuid
-
builderProject
ConnectorBuilderProjectDetails
-
-
-
-

ConnectorBuilderPublishRequestBody - Up

-
-
-
workspaceId
UUID format: uuid
-
builderProjectId
UUID format: uuid
-
name
String
-
initialDeclarativeManifest
DeclarativeSourceManifest
-
-
-
-

CustomDestinationDefinitionCreate - Up

-
-
-
workspaceId
UUID format: uuid
-
destinationDefinition
DestinationDefinitionCreate
-
-
-
-

CustomSourceDefinitionCreate - Up

-
-
-
workspaceId
UUID format: uuid
-
sourceDefinition
SourceDefinitionCreate
-
-
-
-

DataType - Up

-
-
-
-
-
-

DbMigrationExecutionRead - Up

-
-
-
initialVersion (optional)
String
-
targetVersion (optional)
String
-
executedMigrations (optional)
array[DbMigrationRead]
-
-
-
-

DbMigrationRead - Up

-
-
-
migrationType
String
-
migrationVersion
String
-
migrationDescription
String
-
migrationState (optional)
DbMigrationState
-
migratedBy (optional)
String
-
migratedAt (optional)
Long format: int64
-
migrationScript (optional)
String
-
-
-
-

DbMigrationReadList - Up

-
-
-
migrations (optional)
array[DbMigrationRead]
-
-
-
-

DbMigrationRequestBody - Up

-
-
-
database
String
-
-
-
-

DbMigrationState - Up

-
-
-
-
-
-

DeclarativeManifestRead - Up

-
-
-
manifest (optional)
Object Low code CDK manifest JSON object
-
isDraft (optional)
Boolean
-
version (optional)
Long format: int64
-
description (optional)
String
-
-
-
-

DeclarativeManifestVersionRead - Up

-
-
-
version
Long format: int64
-
isActive
Boolean
-
description
String
-
-
-
-

DeclarativeManifestsReadList - Up

-
-
-
manifestVersions
array[DeclarativeManifestVersionRead]
-
-
-
-

DeclarativeSourceDefinitionCreateManifestRequestBody - Up

-
-
-
workspaceId
UUID format: uuid
-
sourceDefinitionId
UUID format: uuid
-
setAsActiveManifest
Boolean
-
declarativeManifest
DeclarativeSourceManifest
-
-
-
-

DeclarativeSourceManifest - Up

-
-
-
description
String
-
manifest
Object Low code CDK manifest JSON object
-
spec
SourceDefinitionSpecification
-
version
Long format: int64
-
-
-
-

DestinationCloneConfiguration - Up

-
-
-
connectionConfiguration (optional)
DestinationConfiguration
-
name (optional)
String
-
-
-
-

DestinationCloneRequestBody - Up

-
The values required to configure the destination. The schema for this should have an id of the existing destination along with the configuration you want to change in case.
-
-
destinationCloneId
UUID format: uuid
-
destinationConfiguration (optional)
DestinationCloneConfiguration
-
-
-
-

DestinationCoreConfig - Up

-
-
-
destinationId (optional)
UUID format: uuid
-
destinationDefinitionId
UUID format: uuid
-
connectionConfiguration
DestinationConfiguration
-
workspaceId
UUID format: uuid
-
-
-
-

DestinationCreate - Up

-
-
-
workspaceId
UUID format: uuid
-
name
String
-
destinationDefinitionId
UUID format: uuid
-
connectionConfiguration
DestinationConfiguration
-
-
-
-

DestinationDefinitionCreate - Up

-
-
-
name
String
-
dockerRepository
String
-
dockerImageTag
String
-
documentationUrl
URI format: uri
-
icon (optional)
String
-
resourceRequirements (optional)
ActorDefinitionResourceRequirements
-
-
-
-

DestinationDefinitionIdRequestBody - Up

-
-
-
destinationDefinitionId
UUID format: uuid
-
-
-
-

DestinationDefinitionIdWithWorkspaceId - Up

-
-
-
destinationDefinitionId
UUID format: uuid
-
workspaceId
UUID format: uuid
-
-
-
-

DestinationDefinitionRead - Up

-
-
-
destinationDefinitionId
UUID format: uuid
-
name
String
-
dockerRepository
String
-
dockerImageTag
String
-
documentationUrl
URI format: uri
-
icon (optional)
String
-
protocolVersion (optional)
String The Airbyte Protocol version supported by the connector
-
releaseStage (optional)
ReleaseStage
-
releaseDate (optional)
date The date when this connector was first released, in yyyy-mm-dd format. format: date
-
resourceRequirements (optional)
ActorDefinitionResourceRequirements
-
supportsDbt
Boolean an optional flag indicating whether DBT is used in the normalization. If the flag value is NULL - DBT is not used.
-
normalizationConfig
NormalizationDestinationDefinitionConfig
-
-
-
-

DestinationDefinitionReadList - Up

-
-
-
destinationDefinitions
array[DestinationDefinitionRead]
-
-
-
-

DestinationDefinitionSpecificationRead - Up

-
-
-
destinationDefinitionId
UUID format: uuid
-
documentationUrl (optional)
String
-
connectionSpecification (optional)
DestinationDefinitionSpecification
-
advancedAuth (optional)
AdvancedAuth
-
jobInfo
SynchronousJobRead
-
supportedDestinationSyncModes (optional)
array[DestinationSyncMode]
-
-
-
-

DestinationDefinitionUpdate - Up

-
-
-
destinationDefinitionId
UUID format: uuid
-
dockerImageTag (optional)
String
-
resourceRequirements (optional)
ActorDefinitionResourceRequirements
-
-
-
-

DestinationIdRequestBody - Up

-
-
-
destinationId
UUID format: uuid
-
-
-
-

DestinationOauthConsentRequest - Up

-
-
-
destinationDefinitionId
UUID format: uuid
-
workspaceId
UUID format: uuid
-
redirectUrl
String The url to redirect to after getting the user consent
-
oAuthInputConfiguration (optional)
OAuthConfiguration
-
destinationId (optional)
UUID format: uuid
-
-
-
-

DestinationRead - Up

-
-
-
destinationDefinitionId
UUID format: uuid
-
destinationId
UUID format: uuid
-
workspaceId
UUID format: uuid
-
connectionConfiguration
DestinationConfiguration
-
name
String
-
destinationName
String
-
icon (optional)
String
-
-
-
-

DestinationReadList - Up

-
-
-
destinations
array[DestinationRead]
-
-
-
-

DestinationSearch - Up

-
-
-
destinationDefinitionId (optional)
UUID format: uuid
-
destinationId (optional)
UUID format: uuid
-
workspaceId (optional)
UUID format: uuid
-
connectionConfiguration (optional)
DestinationConfiguration
-
name (optional)
String
-
destinationName (optional)
String
-
-
-
-

DestinationSnippetRead - Up

-
-
-
destinationId
UUID format: uuid
-
name
String
-
destinationDefinitionId
UUID format: uuid
-
destinationName
String
-
icon (optional)
String
-
-
-
-

DestinationSyncMode - Up

-
-
-
-
-
-

DestinationUpdate - Up

-
-
-
destinationId
UUID format: uuid
-
connectionConfiguration
DestinationConfiguration
-
name
String
-
-
-
-

DiscoverCatalogResult - Up

-
-
-
catalogId
UUID format: uuid
-
-
-
-

ExistingConnectorBuilderProjectWithWorkspaceId - Up

-
-
-
workspaceId
UUID format: uuid
-
builderProjectId
UUID format: uuid
-
builderProject
ConnectorBuilderProjectDetails
-
-
-
-

FailureOrigin - Up

-
Indicates where the error originated. If not set, the origin of error is not well known.
-
-
-
-
-

FailureReason - Up

-
-
-
failureOrigin (optional)
FailureOrigin
-
failureType (optional)
FailureType
-
externalMessage (optional)
String
-
internalMessage (optional)
String
-
stacktrace (optional)
String
-
retryable (optional)
Boolean True if it is known that retrying may succeed, e.g. for a transient failure. False if it is known that a retry will not succeed, e.g. for a configuration issue. If not set, retryable status is not well known.
-
timestamp
Long format: int64
-
-
-
-

FailureType - Up

-
Categorizes well known errors into types for programmatic handling. If not set, the type of error is not well known.
-
-
-
-
-

FieldAdd - Up

-
-
-
schema (optional)
FieldSchema
-
-
-
-

FieldRemove - Up

-
-
-
schema (optional)
FieldSchema
-
-
-
-

FieldSchemaUpdate - Up

-
-
-
oldSchema
FieldSchema
-
newSchema
FieldSchema
-
-
-
-

FieldTransform - Up

-
Describes the difference between two Streams.
-
-
transformType
String
-
Enum:
-
add_field
remove_field
update_field_schema
-
fieldName
array[String] A field name is a list of strings that form the path to the field.
-
breaking
Boolean
-
addField (optional)
FieldAdd
-
removeField (optional)
FieldRemove
-
updateFieldSchema (optional)
FieldSchemaUpdate
-
-
-
-

Geography - Up

-
-
-
-
-
-

GlobalState - Up

-
-
-
shared_state (optional)
StateBlob
-
streamStates
array[StreamState]
-
-
-
-

HealthCheckRead - Up

-
-
-
available
Boolean
-
-
-
-

ImportRead - Up

-
-
-
status
String
-
Enum:
-
succeeded
failed
-
reason (optional)
String
-
-
-
-

ImportRequestBody - Up

-
-
-
resourceId
UUID format: uuid
-
workspaceId
UUID format: uuid
-
-
-
-

InternalOperationResult - Up

-
-
-
succeeded
Boolean
-
-
-
-

InvalidInputExceptionInfo - Up

-
-
-
message
String
-
exceptionClassName (optional)
String
-
exceptionStack (optional)
array[String]
-
validationErrors
array[InvalidInputProperty]
-
-
-
-

InvalidInputProperty - Up

-
-
-
propertyPath
String
-
invalidValue (optional)
String
-
message (optional)
String
-
-
-
-

JobConfigType - Up

-
-
-
-
-
-

JobDebugInfoRead - Up

-
-
-
job
JobDebugRead
-
attempts
array[AttemptInfoRead]
-
workflowState (optional)
WorkflowStateRead
-
-
-
-

JobDebugRead - Up

-
-
-
id
Long format: int64
-
configType
JobConfigType
-
configId
String
-
status
JobStatus
-
airbyteVersion
String
-
sourceDefinition
SourceDefinitionRead
-
destinationDefinition
DestinationDefinitionRead
-
-
-
-

JobIdRequestBody - Up

-
-
-
id
Long format: int64
-
-
-
-

JobInfoLightRead - Up

-
-
-
job
JobRead
-
-
-
-

JobInfoRead - Up

-
-
-
job
JobRead
-
attempts
array[AttemptInfoRead]
-
-
-
-

JobListRequestBody - Up

-
-
-
configTypes
array[JobConfigType]
-
configId
String
-
includingJobId (optional)
Long format: int64
-
pagination (optional)
Pagination
-
-
-
-

JobOptionalRead - Up

-
-
-
job (optional)
JobRead
-
-
-
-

JobRead - Up

-
-
-
id
Long format: int64
-
configType
JobConfigType
-
configId
String
-
enabledStreams (optional)
array[StreamDescriptor]
-
createdAt
Long format: int64
-
updatedAt
Long format: int64
-
startedAt (optional)
Long format: int64
-
status
JobStatus
-
resetConfig (optional)
ResetConfig
-
-
-
-

JobReadList - Up

-
-
-
jobs
array[JobWithAttemptsRead]
-
totalJobCount
Long the total count of jobs for the specified connection format: int64
-
-
-
-

JobStatus - Up

-
-
-
-
-
-

JobType - Up

-
enum that describes the different types of jobs that the platform runs.
-
-
-
-
-

JobTypeResourceLimit - Up

-
sets resource requirements for a specific job type for an actor definition. these values override the default, if both are set.
-
-
jobType
JobType
-
resourceRequirements
ResourceRequirements
-
-
-
-

JobWithAttemptsRead - Up

-
-
-
job (optional)
JobRead
-
attempts (optional)
array[AttemptRead]
-
-
-
-

KnownExceptionInfo - Up

-
-
-
message
String
-
exceptionClassName (optional)
String
-
exceptionStack (optional)
array[String]
-
rootCauseExceptionClassName (optional)
String
-
rootCauseExceptionStack (optional)
array[String]
-
-
-
-

ListConnectionsForWorkspacesRequestBody - Up

-
-
-
workspaceIds
array[UUID] format: uuid
-
userId
UUID format: uuid
-
pagination (optional)
Pagination
-
includeDeleted (optional)
Boolean
-
-
-
-

ListDeclarativeManifestsRequestBody - Up

-
-
-
workspaceId
UUID format: uuid
-
sourceDefinitionId
UUID format: uuid
-
-
-
-

ListResourcesForWorkspacesRequestBody - Up

-
-
-
workspaceIds
array[UUID] format: uuid
-
includeDeleted (optional)
Boolean
-
pagination (optional)
Pagination
-
-
-
-

LogRead - Up

-
-
-
logLines
array[String]
-
-
-
-

LogType - Up

-
type/source of logs produced
-
-
-
-
-

LogsRequestBody - Up

-
-
-
logType
LogType
-
-
-
-

NamespaceDefinitionType - Up

-
Method used for computing final namespace in destination
-
-
-
-
-

NonBreakingChangesPreference - Up

-
-
-
-
-
-

NormalizationDestinationDefinitionConfig - Up

-
describes a normalization config for destination definition
-
-
supported
Boolean whether the destination definition supports normalization.
-
normalizationRepository (optional)
String a field indicating the name of the repository to be used for normalization. If the value of the flag is NULL - normalization is not used.
-
normalizationTag (optional)
String a field indicating the tag of the docker repository to be used for normalization.
-
normalizationIntegrationType (optional)
String a field indicating the type of integration dialect to use for normalization.
-
-
-
-

NotFoundKnownExceptionInfo - Up

-
-
-
id (optional)
String
-
message
String
-
exceptionClassName (optional)
String
-
exceptionStack (optional)
array[String]
-
rootCauseExceptionClassName (optional)
String
-
rootCauseExceptionStack (optional)
array[String]
-
-
-
-

Notification - Up

-
-
-
notificationType
NotificationType
-
sendOnSuccess
Boolean
-
sendOnFailure
Boolean
-
slackConfiguration (optional)
SlackNotificationConfiguration
-
customerioConfiguration (optional)
Object
-
-
-
-

NotificationItem - Up

-
-
-
notificationType (optional)
array[NotificationType]
-
slackConfiguration (optional)
SlackNotificationConfiguration
-
customerioConfiguration (optional)
Object
-
-
-
-

NotificationRead - Up

-
-
-
status
String
-
Enum:
-
succeeded
failed
-
message (optional)
String
-
-
-
-

NotificationSettings - Up

-
-
-
sendOnSuccess (optional)
NotificationItem
-
sendOnFailure (optional)
NotificationItem
-
sendOnSyncDisabled (optional)
NotificationItem
-
sendOnSyncDisabledWarning (optional)
NotificationItem
-
sendOnConnectionUpdate (optional)
NotificationItem
-
sendOnConnectionUpdateActionRequired (optional)
NotificationItem
-
-
-
-

NotificationType - Up

-
-
-
-
-
-

OAuthConfigSpecification - Up

-
-
-
oauthUserInputFromConnectorConfigSpecification (optional)
OAuthConfiguration
-
completeOAuthOutputSpecification (optional)
OAuthConfiguration
-
completeOAuthServerInputSpecification (optional)
OAuthConfiguration
-
completeOAuthServerOutputSpecification (optional)
OAuthConfiguration
-
-
-
-

OAuthConsentRead - Up

-
-
-
consentUrl
String
-
-
-
-

OperationCreate - Up

-
-
-
workspaceId
UUID format: uuid
-
name
String
-
operatorConfiguration
OperatorConfiguration
-
-
-
-

OperationIdRequestBody - Up

-
-
-
operationId
UUID format: uuid
-
-
-
-

OperationRead - Up

-
-
-
workspaceId
UUID format: uuid
-
operationId
UUID format: uuid
-
name
String
-
operatorConfiguration
OperatorConfiguration
-
-
-
-

OperationReadList - Up

-
-
-
operations
array[OperationRead]
-
-
-
-

OperationUpdate - Up

-
-
-
operationId
UUID format: uuid
-
name
String
-
operatorConfiguration
OperatorConfiguration
-
-
-
-

OperatorConfiguration - Up

-
-
-
operatorType
OperatorType
-
normalization (optional)
OperatorNormalization
-
dbt (optional)
OperatorDbt
-
webhook (optional)
OperatorWebhook
-
-
-
-

OperatorDbt - Up

-
-
-
gitRepoUrl
String
-
gitRepoBranch (optional)
String
-
dockerImage (optional)
String
-
dbtArguments (optional)
String
-
-
-
-

OperatorNormalization - Up

-
-
-
option (optional)
String
-
Enum:
-
basic
-
-
-
-

OperatorType - Up

-
-
-
-
-
-

OperatorWebhook - Up

-
-
-
webhookConfigId (optional)
UUID The id of the webhook configs to use from the workspace. format: uuid
-
webhookType (optional)
String
-
Enum:
-
dbtCloud
-
dbtCloud (optional)
OperatorWebhook_dbtCloud
-
executionUrl (optional)
String DEPRECATED. Populate dbtCloud instead.
-
executionBody (optional)
String DEPRECATED. Populate dbtCloud instead.
-
-
-
-

OperatorWebhook_dbtCloud - Up

-
-
-
accountId
Integer The account id associated with the job
-
jobId
Integer The job id associated with the job
-
-
-
-

Pagination - Up

-
-
-
pageSize (optional)
Integer
-
rowOffset (optional)
Integer
-
-
-
-

PartialDestinationUpdate - Up

-
-
-
destinationId (optional)
UUID format: uuid
-
connectionConfiguration (optional)
DestinationConfiguration
-
name (optional)
String
-
-
-
-

PartialSourceUpdate - Up

-
-
-
sourceId
UUID format: uuid
-
connectionConfiguration (optional)
SourceConfiguration
-
name (optional)
String
-
secretId (optional)
String
-
-
-
-

PrivateDestinationDefinitionRead - Up

-
-
-
destinationDefinition
DestinationDefinitionRead
-
granted
Boolean
-
-
-
-

PrivateDestinationDefinitionReadList - Up

-
-
-
destinationDefinitions
array[PrivateDestinationDefinitionRead]
-
-
-
-

PrivateSourceDefinitionRead - Up

-
-
-
sourceDefinition
SourceDefinitionRead
-
granted
Boolean
-
-
-
-

PrivateSourceDefinitionReadList - Up

-
-
-
sourceDefinitions
array[PrivateSourceDefinitionRead]
-
-
-
-

ReleaseStage - Up

-
-
-
-
-
-

ResetConfig - Up

-
contains information about how a reset was configured. only populated if the job was a reset.
-
-
streamsToReset (optional)
array[StreamDescriptor]
-
-
-
-

ResourceRequirements - Up

-
optional resource requirements to run workers (blank for unbounded allocations)
-
-
cpu_request (optional)
String
-
cpu_limit (optional)
String
-
memory_request (optional)
String
-
memory_limit (optional)
String
-
-
-
-

RevokeSourceOauthTokensRequest - Up

-
-
-
workspaceId
UUID format: uuid
-
sourceId
UUID format: uuid
-
sourceDefinitionId
UUID format: uuid
-
-
-
-

SaveAttemptSyncConfigRequestBody - Up

-
-
-
jobId
Long format: int64
-
attemptNumber
Integer format: int32
-
syncConfig
AttemptSyncConfig
-
-
-
-

SaveStatsRequestBody - Up

-
-
-
jobId
Long format: int64
-
attemptNumber
Integer format: int32
-
stats
AttemptStats
-
streamStats (optional)
array[AttemptStreamStats]
-
-
-
-

SchemaChange - Up

-
-
-
-
-
-

SelectedFieldInfo - Up

-
Path to a field/column/property in a stream to be selected. For example, if the field to be selected is a database column called "foo", this will be ["foo"]. Use multiple path elements for nested schemas.
-
-
fieldPath (optional)
array[String]
-
-
-
-

SetInstancewideDestinationOauthParamsRequestBody - Up

-
-
-
destinationDefinitionId
UUID format: uuid
-
params
map[String, oas_any_type_not_mapped]
-
-
-
-

SetInstancewideSourceOauthParamsRequestBody - Up

-
-
-
sourceDefinitionId
UUID format: uuid
-
params
map[String, oas_any_type_not_mapped]
-
-
-
-

SetWorkflowInAttemptRequestBody - Up

-
-
-
jobId
Long format: int64
-
attemptNumber
Integer format: int32
-
workflowId
String
-
processingTaskQueue (optional)
String
-
-
-
-

SlackNotificationConfiguration - Up

-
-
-
webhook
String
-
-
-
-

SlugRequestBody - Up

-
-
-
slug
String
-
-
-
-

SourceAutoPropagateChange - Up

-
Input of the source propagation, it contains the discovered catalog and a list of diff that need to be applied to the existing catalog.
-
-
catalog
AirbyteCatalog
-
catalogId
UUID format: uuid
-
sourceId
UUID format: uuid
-
workspaceId
UUID format: uuid
-
-
-
-

SourceCloneConfiguration - Up

-
-
-
connectionConfiguration (optional)
SourceConfiguration
-
name (optional)
String
-
-
-
-

SourceCloneRequestBody - Up

-
The values required to configure the source. The schema for this should have an id of the existing source along with the configuration you want to change in case.
-
-
sourceCloneId
UUID format: uuid
-
sourceConfiguration (optional)
SourceCloneConfiguration
-
-
-
-

SourceCoreConfig - Up

-
-
-
sourceId (optional)
UUID format: uuid
-
sourceDefinitionId
UUID format: uuid
-
connectionConfiguration
SourceConfiguration
-
workspaceId
UUID format: uuid
-
-
-
-

SourceCreate - Up

-
-
-
sourceDefinitionId
UUID format: uuid
-
connectionConfiguration
SourceConfiguration
-
workspaceId
UUID format: uuid
-
name
String
-
secretId (optional)
String
-
-
-
-

SourceDefinitionCreate - Up

-
-
-
name
String
-
dockerRepository
String
-
dockerImageTag
String
-
documentationUrl
URI format: uri
-
icon (optional)
String
-
resourceRequirements (optional)
ActorDefinitionResourceRequirements
-
-
-
-

SourceDefinitionIdBody - Up

-
-
-
sourceDefinitionId
UUID format: uuid
-
-
-
-

SourceDefinitionIdRequestBody - Up

-
-
-
sourceDefinitionId
UUID format: uuid
-
-
-
-

SourceDefinitionIdWithWorkspaceId - Up

-
-
-
sourceDefinitionId
UUID format: uuid
-
workspaceId
UUID format: uuid
-
-
-
-

SourceDefinitionRead - Up

-
-
-
sourceDefinitionId
UUID format: uuid
-
name
String
-
dockerRepository
String
-
dockerImageTag
String
-
documentationUrl (optional)
URI format: uri
-
icon (optional)
String
-
protocolVersion (optional)
String The Airbyte Protocol version supported by the connector
-
releaseStage (optional)
ReleaseStage
-
releaseDate (optional)
date The date when this connector was first released, in yyyy-mm-dd format. format: date
-
sourceType (optional)
String
-
Enum:
-
api
file
database
custom
-
resourceRequirements (optional)
ActorDefinitionResourceRequirements
-
maxSecondsBetweenMessages (optional)
Long Number of seconds allowed between 2 airbyte protocol messages. The source will timeout if this delay is reach format: int64
-
-
-
-

SourceDefinitionReadList - Up

-
-
-
sourceDefinitions
array[SourceDefinitionRead]
-
-
-
-

SourceDefinitionSpecificationRead - Up

-
-
-
sourceDefinitionId
UUID format: uuid
-
documentationUrl (optional)
String
-
connectionSpecification (optional)
SourceDefinitionSpecification
-
advancedAuth (optional)
AdvancedAuth
-
jobInfo
SynchronousJobRead
-
-
-
-

SourceDefinitionUpdate - Up

-
Update the SourceDefinition. Currently, the only allowed attribute to update is the default docker image version.
-
-
sourceDefinitionId
UUID format: uuid
-
dockerImageTag
String
-
resourceRequirements (optional)
ActorDefinitionResourceRequirements
-
-
-
-

SourceDiscoverSchemaRead - Up

-
Returns the results of a discover catalog job. If the job was not successful, the catalog field will not be present. jobInfo will aways be present and its status be used to determine if the job was successful or not.
-
-
catalog (optional)
AirbyteCatalog
-
jobInfo
SynchronousJobRead
-
catalogId (optional)
UUID format: uuid
-
catalogDiff (optional)
CatalogDiff
-
breakingChange (optional)
Boolean
-
connectionStatus (optional)
ConnectionStatus
-
-
-
-

SourceDiscoverSchemaRequestBody - Up

-
-
-
sourceId
UUID format: uuid
-
connectionId (optional)
UUID format: uuid
-
disable_cache (optional)
Boolean
-
notifySchemaChange (optional)
Boolean
-
-
-
-

SourceDiscoverSchemaWriteRequestBody - Up

-
to write this requested object to database.
-
-
catalog
AirbyteCatalog
-
sourceId (optional)
UUID format: uuid
-
connectorVersion (optional)
String
-
configurationHash (optional)
String
-
-
-
-

SourceIdRequestBody - Up

-
-
-
sourceId
UUID format: uuid
-
-
-
-

SourceOauthConsentRequest - Up

-
-
-
sourceDefinitionId
UUID format: uuid
-
workspaceId
UUID format: uuid
-
redirectUrl
String The url to redirect to after getting the user consent
-
oAuthInputConfiguration (optional)
OAuthConfiguration
-
sourceId (optional)
UUID format: uuid
-
-
-
-

SourceRead - Up

-
-
-
sourceDefinitionId
UUID format: uuid
-
sourceId
UUID format: uuid
-
workspaceId
UUID format: uuid
-
connectionConfiguration
SourceConfiguration
-
name
String
-
sourceName
String
-
icon (optional)
String
-
-
-
-

SourceReadList - Up

-
-
-
sources
array[SourceRead]
-
-
-
-

SourceSearch - Up

-
-
-
sourceDefinitionId (optional)
UUID format: uuid
-
sourceId (optional)
UUID format: uuid
-
workspaceId (optional)
UUID format: uuid
-
connectionConfiguration (optional)
SourceConfiguration
-
name (optional)
String
-
sourceName (optional)
String
-
-
-
-

SourceSnippetRead - Up

-
-
-
sourceId
UUID format: uuid
-
name
String
-
sourceDefinitionId
UUID format: uuid
-
sourceName
String
-
icon (optional)
String
-
-
-
-

SourceUpdate - Up

-
-
-
sourceId
UUID format: uuid
-
connectionConfiguration
SourceConfiguration
-
name
String
-
secretId (optional)
String
-
-
-
-

StreamDescriptor - Up

-
-
-
name
String
-
namespace (optional)
String
-
-
-
-

StreamState - Up

-
-
-
streamDescriptor
StreamDescriptor
-
streamState (optional)
StateBlob
-
-
-
-

StreamStatusCreateRequestBody - Up

-
-
-
attemptNumber
Integer format: int32
-
connectionId
UUID format: uuid
-
jobId
Long format: int64
-
incompleteRunCause (optional)
StreamStatusIncompleteRunCause
-
jobType
StreamStatusJobType
-
runState
StreamStatusRunState
-
streamName
String
-
streamNamespace (optional)
String
-
transitionedAt
Long format: int64
-
workspaceId
UUID format: uuid
-
-
-
-

StreamStatusIncompleteRunCause - Up

-

Values:

-
    -
  • FAILED - A failure has occurred
    • -
  • CANCELED - The run has been canceled
    • -
-
-
-
-
-
-

StreamStatusJobType - Up

-
-
-
-
-
-

StreamStatusListRequestBody - Up

-
-
-
attemptNumber (optional)
Integer format: int32
-
connectionId (optional)
UUID format: uuid
-
jobId (optional)
Long format: int64
-
jobType (optional)
StreamStatusJobType
-
pagination
Pagination
-
streamName (optional)
String
-
streamNamespace (optional)
String
-
workspaceId
UUID format: uuid
-
-
-
-

StreamStatusRead - Up

-
-
-
attemptNumber
Integer format: int32
-
connectionId
UUID format: uuid
-
id
UUID format: uuid
-
jobId
Long format: int64
-
incompleteRunCause (optional)
StreamStatusIncompleteRunCause
-
jobType
StreamStatusJobType
-
runState
StreamStatusRunState
-
streamName
String
-
streamNamespace
String
-
transitionedAt
Long format: int64
-
workspaceId
UUID format: uuid
-
-
-
-

StreamStatusReadList - Up

-
-
-
streamStatuses (optional)
array[StreamStatusRead]
-
-
-
-

StreamStatusRunState - Up

-

Values:

-
    -
  • PENDING - The stream operation has been selected to run
    • -
  • RUNNING - The stream operation is running
    • -
  • COMPLETE - The stream operation ran successfully to completion
    • -
  • INCOMPLETE - The stream operation has terminated in an incomplete state. -See StreamStatusIncompleteRunCause for more details.
    • -
-
-
-
-
-
-

StreamStatusUpdateRequestBody - Up

-
-
-
id
UUID format: uuid
-
attemptNumber
Integer format: int32
-
connectionId
UUID format: uuid
-
jobId
Long format: int64
-
incompleteRunCause (optional)
StreamStatusIncompleteRunCause
-
jobType
StreamStatusJobType
-
runState
StreamStatusRunState
-
streamName
String
-
streamNamespace (optional)
String
-
transitionedAt
Long format: int64
-
workspaceId
UUID format: uuid
-
-
-
-

StreamTransform - Up

-
-
-
transformType
String
-
Enum:
-
add_stream
remove_stream
update_stream
-
streamDescriptor
StreamDescriptor
-
updateStream (optional)
array[FieldTransform] list of field transformations. order does not matter.
-
-
-
-

SyncMode - Up

-
-
-
-
-
-

SynchronousJobRead - Up

-
-
-
id
UUID format: uuid
-
configType
JobConfigType
-
configId (optional)
String only present if a config id was provided.
-
createdAt
Long format: int64
-
endedAt
Long format: int64
-
succeeded
Boolean
-
connectorConfigurationUpdated (optional)
Boolean
-
logs (optional)
LogRead
-
failureReason (optional)
FailureReason
-
-
-
-

UpdateActiveManifestRequestBody - Up

-
-
-
workspaceId
UUID format: uuid
-
sourceDefinitionId
UUID format: uuid
-
version
Long format: int64
-
-
-
-

UploadRead - Up

-
-
-
status
String
-
Enum:
-
succeeded
failed
-
resourceId (optional)
UUID format: uuid
-
-
-
-

WebBackendCheckUpdatesRead - Up

-
Summary of source and destination definitions that could be updated
-
-
destinationDefinitions
Integer
-
sourceDefinitions
Integer
-
-
-
-

WebBackendConnectionCreate - Up

-
-
-
name (optional)
String Optional name of the connection
-
namespaceDefinition (optional)
NamespaceDefinitionType
-
namespaceFormat (optional)
String Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
-
prefix (optional)
String Prefix that will be prepended to the name of each stream when it is written to the destination.
-
sourceId
UUID format: uuid
-
destinationId
UUID format: uuid
-
operationIds (optional)
array[UUID] format: uuid
-
syncCatalog (optional)
AirbyteCatalog
-
schedule (optional)
ConnectionSchedule
-
scheduleType (optional)
ConnectionScheduleType
-
scheduleData (optional)
ConnectionScheduleData
-
status
ConnectionStatus
-
resourceRequirements (optional)
ResourceRequirements
-
operations (optional)
array[OperationCreate]
-
sourceCatalogId (optional)
UUID format: uuid
-
geography (optional)
Geography
-
nonBreakingChangesPreference (optional)
NonBreakingChangesPreference
-
-
-
-

WebBackendConnectionListItem - Up

-
Information about a connection that shows up in the connection list view.
-
-
connectionId
UUID format: uuid
-
name
String
-
scheduleType (optional)
ConnectionScheduleType
-
scheduleData (optional)
ConnectionScheduleData
-
status
ConnectionStatus
-
source
SourceSnippetRead
-
destination
DestinationSnippetRead
-
latestSyncJobCreatedAt (optional)
Long epoch time of the latest sync job. null if no sync job has taken place. format: int64
-
latestSyncJobStatus (optional)
JobStatus
-
isSyncing
Boolean
-
schemaChange
SchemaChange
-
-
-
-

WebBackendConnectionListRequestBody - Up

-
-
-
workspaceId
UUID format: uuid
-
sourceId (optional)
array[UUID] format: uuid
-
destinationId (optional)
array[UUID] format: uuid
-
-
-
-

WebBackendConnectionRead - Up

-
-
-
connectionId
UUID format: uuid
-
name
String
-
namespaceDefinition (optional)
NamespaceDefinitionType
-
namespaceFormat (optional)
String Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
-
prefix (optional)
String Prefix that will be prepended to the name of each stream when it is written to the destination.
-
sourceId
UUID format: uuid
-
destinationId
UUID format: uuid
-
syncCatalog
AirbyteCatalog
-
schedule (optional)
ConnectionSchedule
-
scheduleType (optional)
ConnectionScheduleType
-
scheduleData (optional)
ConnectionScheduleData
-
status
ConnectionStatus
-
operationIds (optional)
array[UUID] format: uuid
-
source
SourceRead
-
destination
DestinationRead
-
operations (optional)
array[OperationRead]
-
latestSyncJobCreatedAt (optional)
Long epoch time of the latest sync job. null if no sync job has taken place. format: int64
-
latestSyncJobStatus (optional)
JobStatus
-
isSyncing
Boolean
-
resourceRequirements (optional)
ResourceRequirements
-
catalogId (optional)
UUID format: uuid
-
catalogDiff (optional)
CatalogDiff
-
geography (optional)
Geography
-
schemaChange
SchemaChange
-
notifySchemaChanges
Boolean
-
notifySchemaChangesByEmail
Boolean
-
nonBreakingChangesPreference
NonBreakingChangesPreference
-
-
-
-

WebBackendConnectionReadList - Up

-
-
-
connections
array[WebBackendConnectionListItem]
-
-
-
-

WebBackendConnectionRequestBody - Up

-
-
-
withRefreshedCatalog (optional)
Boolean
-
connectionId
UUID format: uuid
-
-
-
-

WebBackendConnectionUpdate - Up

-
Used to apply a patch-style update to a connection, which means that null properties remain unchanged
-
-
name (optional)
String Name that will be set to the connection
-
connectionId
UUID format: uuid
-
namespaceDefinition (optional)
NamespaceDefinitionType
-
namespaceFormat (optional)
String Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
-
prefix (optional)
String Prefix that will be prepended to the name of each stream when it is written to the destination.
-
syncCatalog (optional)
AirbyteCatalog
-
schedule (optional)
ConnectionSchedule
-
scheduleType (optional)
ConnectionScheduleType
-
scheduleData (optional)
ConnectionScheduleData
-
status (optional)
ConnectionStatus
-
resourceRequirements (optional)
ResourceRequirements
-
skipReset (optional)
Boolean
-
operations (optional)
array[WebBackendOperationCreateOrUpdate]
-
sourceCatalogId (optional)
UUID format: uuid
-
geography (optional)
Geography
-
notifySchemaChanges (optional)
Boolean
-
notifySchemaChangesByEmail (optional)
Boolean
-
nonBreakingChangesPreference (optional)
NonBreakingChangesPreference
-
-
-
-

WebBackendGeographiesListResult - Up

-
-
-
geographies
array[Geography]
-
-
-
-

WebBackendOperationCreateOrUpdate - Up

-
-
-
operationId (optional)
UUID format: uuid
-
workspaceId
UUID format: uuid
-
name
String
-
operatorConfiguration
OperatorConfiguration
-
-
-
-

WebBackendWorkspaceState - Up

-
-
-
workspaceId
UUID format: uuid
-
-
-
-

WebBackendWorkspaceStateResult - Up

-
-
-
hasConnections
Boolean
-
hasSources
Boolean
-
hasDestinations
Boolean
-
-
-
-

WebhookConfigRead - Up

-
the readable info for a webhook config; omits sensitive info e.g. auth token
-
-
id
UUID format: uuid
-
name (optional)
String human-readable name e.g. for display in UI
-
-
-
-

WebhookConfigWrite - Up

-
-
-
name (optional)
String human readable name for this webhook e.g. for UI display.
-
authToken (optional)
String an auth token, to be passed as the value for an HTTP Authorization header.
-
validationUrl (optional)
String if supplied, the webhook config will be validated by checking that this URL returns a 2xx response.
-
-
-
-

WorkflowStateRead - Up

-
-
-
running
Boolean
-
-
-
-

WorkspaceCreate - Up

-
-
-
email (optional)
String format: email
-
anonymousDataCollection (optional)
Boolean
-
name
String
-
news (optional)
Boolean
-
securityUpdates (optional)
Boolean
-
notifications (optional)
array[Notification]
-
notificationSettings (optional)
NotificationSettings
-
displaySetupWizard (optional)
Boolean
-
defaultGeography (optional)
Geography
-
webhookConfigs (optional)
array[WebhookConfigWrite]
-
-
-
-

WorkspaceGiveFeedback - Up

-
-
-
workspaceId
UUID format: uuid
-
-
-
-

WorkspaceIdRequestBody - Up

-
-
-
workspaceId
UUID format: uuid
-
-
-
-

WorkspaceOverrideOauthParamsRequestBody - Up

-
-
-
definitionId
UUID format: uuid
-
params
map[String, oas_any_type_not_mapped]
-
workspaceId
UUID format: uuid
-
actorType
ActorType
-
-
-
-

WorkspaceRead - Up

-
-
-
workspaceId
UUID format: uuid
-
customerId
UUID format: uuid
-
email (optional)
String format: email
-
name
String
-
slug
String
-
initialSetupComplete
Boolean
-
displaySetupWizard (optional)
Boolean
-
anonymousDataCollection (optional)
Boolean
-
news (optional)
Boolean
-
securityUpdates (optional)
Boolean
-
notifications (optional)
array[Notification]
-
notificationSettings (optional)
NotificationSettings
-
firstCompletedSync (optional)
Boolean
-
feedbackDone (optional)
Boolean
-
defaultGeography (optional)
Geography
-
webhookConfigs (optional)
array[WebhookConfigRead]
-
-
-
-

WorkspaceReadList - Up

-
-
-
workspaces
array[WorkspaceRead]
-
-
-
-

WorkspaceUpdate - Up

-
Used to apply a patch-style update to a workspace, which means that null properties remain unchanged
-
-
workspaceId
UUID format: uuid
-
email (optional)
String format: email
-
initialSetupComplete (optional)
Boolean
-
displaySetupWizard (optional)
Boolean
-
anonymousDataCollection (optional)
Boolean
-
news (optional)
Boolean
-
securityUpdates (optional)
Boolean
-
notifications (optional)
array[Notification]
-
notificationSettings (optional)
NotificationSettings
-
defaultGeography (optional)
Geography
-
webhookConfigs (optional)
array[WebhookConfigWrite]
-
-
-
-

WorkspaceUpdateName - Up

-
-
-
workspaceId
UUID format: uuid
-
name
String
-
-
- - diff --git a/docs/reference/api/rapidoc-api-docs.html b/docs/reference/api/rapidoc-api-docs.html deleted file mode 100644 index 7faefd948b93..000000000000 --- a/docs/reference/api/rapidoc-api-docs.html +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - diff --git a/docs/release_notes/march_2024.md b/docs/release_notes/march_2024.md index 55eb7c5e4a91..4dc0c633dde5 100644 --- a/docs/release_notes/march_2024.md +++ b/docs/release_notes/march_2024.md @@ -16,7 +16,7 @@ Airbyte migrated our [Redshift destination](https://github.com/airbytehq/airbyte In addition to our OpenID Connect support, we also released: -- A major upgrade to our Docker and Helm deployments, which simplifies how external logs are configured. Learn more about the specific changes in our [migration guide](/deploying-airbyte/on-kubernetes-via-helm#migrate-from-old-chart-to-airbyte-v0520-and-latest-chart-version). +- A major upgrade to our Docker and Helm deployments, which simplifies how external logs are configured. - A breaking change to Docker deployments. Containers no longer run as the `root` user. If you are upgrading from an older version, the `airbyte_workspace` docker volume must be recreated to fix the ownership of staging directories under `/tmp` (in the container). Alternatively, you can manually update the ownership (`airbyte:airbyte`) of the directory mount point /tmp/workspace in all containers where `airbyte_workspace` is mounted (see: `docker-compose.yaml`) diff --git a/docs/using-airbyte/core-concepts/sync-modes/incremental-append-deduped.md b/docs/using-airbyte/core-concepts/sync-modes/incremental-append-deduped.md index 7e3ad86a1b98..f08261b56574 100644 --- a/docs/using-airbyte/core-concepts/sync-modes/incremental-append-deduped.md +++ b/docs/using-airbyte/core-concepts/sync-modes/incremental-append-deduped.md @@ -6,12 +6,13 @@ products: all ## High-Level Context -This connector syncs data **incrementally**, which means that only new or modified data will be synced. In contrast with the [Incremental Append mode](./incremental-append.md), this mode updates rows that have been modified instead of adding a new version of the row with the updated data. Simply put, if you've synced a row before and it has since been updated, this mode will combine the two rows -in the destination and use the most recent data. On the other hand, the [Incremental Append mode](./incremental-append.md) would just add a new row with the updated data. +This sync mode syncs data **incrementally**, which means that only new or modified data will be synced. In contrast with the [Incremental Append mode](./incremental-append.md), this mode updates rows that have been modified instead of adding a new version of the row with the updated data. + +If you've synced a row before and it has since been updated, this sync mode will combine the two rows in the destination and use the most recent data. On the other hand, the [Incremental Append mode](./incremental-append.md) would just add a new row with the updated data. ## Overview -Airbyte supports syncing data in **Incremental Append Deduped** mode i.e: +Airbyte supports syncing data in **Incremental | Append + Deduped** mode: 1. **Incremental** means syncing only replicate _new_ or _modified_ data. This prevents re-fetching data that you have already replicated from a source. If the sync is running for the first time, it is equivalent to a [Full Refresh](full-refresh-append.md) since all data will be considered as _new_. 2. **Append** means that this incremental data is added to existing tables in your data warehouse. @@ -73,33 +74,23 @@ In the final de-duplicated table: ## Source-Defined Cursor -Some sources are able to determine the cursor that they use without any user input. For example, in the [exchange rates source](../../../integrations/sources/exchange-rates.md), the source knows that the date field should be used to determine the last record that was synced. In these cases, simply select the incremental option in the UI. - -![](../../../.gitbook/assets/incremental_source_defined.png) +Some sources are able to determine the cursor that they use without any user input. For example, in the [Exchange Rates source](../../../integrations/sources/exchange-rates.md), the source already knows that the date field should be used to determine the last record that was synced. In these cases, simply select the incremental sync mode in the UI by navigating to the `Schema` tab for a connection. -\(You can find a more technical details about the configuration data model [here](../../../understanding-airbyte/airbyte-protocol.md#catalog)\). +You can find a more technical details about the configuration data model [here](../../../understanding-airbyte/airbyte-protocol.md#catalog). ## User-Defined Cursor -Some sources cannot define the cursor without user input. For example, in the [postgres source](../../../integrations/sources/postgres.md), the user needs to choose which column in a database table they want to use as the `cursor field`. In these cases, select the column in the sync settings dropdown that should be used as the `cursor field`. - -![](../../../.gitbook/assets/incremental_user_defined.png) +Some sources are unable to define the cursor without user input. For example, in the [Postgres source](../../../integrations/sources/postgres.md), the user needs to choose which column in a database table they want to use as the `cursor`. In these cases, simply select the `cursor` for each stream in the UI by navigating to the `Schema` tab for a connection. -\(You can find a more technical details about the configuration data model [here](../../../understanding-airbyte/airbyte-protocol.md#catalog)\). +You can find a more technical details about the configuration data model [here](../../../understanding-airbyte/airbyte-protocol.md#catalog). ## Source-Defined Primary key -Some sources are able to determine the primary key that they use without any user input. For example, in the \(JDBC\) Database sources, primary key can be defined in the table's metadata. +Some sources are able to determine the primary key that they use without any user input. For example, in JDBC database sources, the primary key can be defined in the table's metadata. Most APIs also have pre-determined primary keys. ## User-Defined Primary key -Some sources cannot define the cursor without user input or the user may want to specify their own primary key on the destination that is different from the source definitions. In these cases, select the column in the sync settings dropdown that should be used as the `primary key` or `composite primary keys`. - -![](../../../.gitbook/assets/primary_key_user_defined.png) - -In this example, we selected both the `campaigns.id` and `campaigns.name` as the composite primary key of our `campaigns` table. - -Note that in **Incremental Deduped History**, the size of the data in your warehouse increases monotonically since an updated record in the source is appended to the destination history table rather than updated in-place as it is done with the final table. If you only care about having the latest snapshot of your data, you may want to periodically run cleanup jobs which retain only the latest instance of each record in the history tables. +Some sources cannot define the primary key without user input or the user may want to specify their own primary key on the destination that is different from the source definition. In these cases, select the field in the stream that should be used as the `primary key`. Multiple primary keys can also be selected to form a `composite primary key`. ## Inclusive Cursors diff --git a/docs/using-airbyte/core-concepts/sync-modes/incremental-append.md b/docs/using-airbyte/core-concepts/sync-modes/incremental-append.md index 3a9c01859714..5697552754a3 100644 --- a/docs/using-airbyte/core-concepts/sync-modes/incremental-append.md +++ b/docs/using-airbyte/core-concepts/sync-modes/incremental-append.md @@ -6,7 +6,7 @@ products: all ## Overview -Airbyte supports syncing data in **Incremental Append** mode i.e: syncing only replicate _new_ or _modified_ data. This prevents re-fetching data that you have already replicated from a source. If the sync is running for the first time, it is equivalent to a [Full Refresh](./full-refresh-append.md) since all data will be considered as _new_. +Airbyte supports syncing data in **Incremental | Append** mode, which syncs only replicate _new_ or _modified_ data. This prevents re-fetching data that you have already replicated from a source. If the sync is running for the first time, it is equivalent to a [Full Refresh](./full-refresh-append.md) since all data will be considered as _new_. In this flavor of incremental, records in the warehouse destination will never be deleted or mutated. A copy of each new or updated record is _appended_ to the data in the warehouse. This means you can find multiple copies of the same record in the destination warehouse. We provide an "at least once" guarantee of replicating each record that is present when the sync runs. @@ -66,27 +66,23 @@ The output we expect to see in the warehouse is as follows: ## Source-Defined Cursor -Some sources are able to determine the cursor that they use without any user input. For example, in the [exchange rates source](../../../integrations/sources/exchange-rates.md), the source knows that the date field should be used to determine the last record that was synced. In these cases, simply select the incremental option in the UI. +Some sources are able to determine the cursor that they use without any user input. For example, in the [Exchange Rates source](../../../integrations/sources/exchange-rates.md), the source already knows that the date field should be used to determine the last record that was synced. In these cases, simply select the incremental sync mode in the UI by navigating to the `Schema` tab for a connection. -![](../../../.gitbook/assets/incremental_source_defined.png) - -\(You can find a more technical details about the configuration data model [here](../../../understanding-airbyte/airbyte-protocol.md#catalog)\). +You can find a more technical details about the configuration data model [here](../../../understanding-airbyte/airbyte-protocol.md#catalog). ## User-Defined Cursor -Some sources cannot define the cursor without user input. For example, in the [postgres source](../../../integrations/sources/postgres.md), the user needs to choose which column in a database table they want to use as the `cursor field`. In these cases, select the column in the sync settings dropdown that should be used as the `cursor field`. - -![](../../../.gitbook/assets/incremental_user_defined.png) +Some sources are unable to define the cursor without user input. For example, in the [Postgres source](../../../integrations/sources/postgres.md), the user needs to choose which column in a database table they want to use as the `cursor`. In these cases, simply select the `cursor` for each stream in the UI by navigating to the `Schema` tab for a connection. -\(You can find a more technical details about the configuration data model [here](../../../understanding-airbyte/airbyte-protocol.md#catalog)\). +You can find a more technical details about the configuration data model [here](../../../understanding-airbyte/airbyte-protocol.md#catalog). -## Getting the Latest Snapshot of data +## Finding the Latest Snapshot of data As demonstrated in the examples above, with **Incremental Append,** a record which was updated in the source will be appended to the destination rather than updated in-place. This means that if data in the source uses a primary key \(e.g: `user_id` in the `users` table\), then the destination will end up having multiple records with the same primary key value. However, some use cases require only the latest snapshot of the data. This is available by using other flavors of sync modes such as [Incremental - Append + Deduped](./incremental-append-deduped.md) instead. -Note that in **Incremental Append**, the size of the data in your warehouse increases monotonically since an updated record in the source is appended to the destination rather than updated in-place. +Note that in **Incremental | Append**, the size of the data in your warehouse increases monotonically since an updated record in the source is appended to the destination rather than updated in-place. If you only care about having the latest snapshot of your data, you may want to look at other sync modes that will keep smaller copies of the replicated data or you can periodically run cleanup jobs which retain only the latest instance of each record. diff --git a/docs/using-airbyte/workspaces.md b/docs/using-airbyte/workspaces.md index 72bdd2a458f6..66d50f360ac4 100644 --- a/docs/using-airbyte/workspaces.md +++ b/docs/using-airbyte/workspaces.md @@ -48,14 +48,17 @@ Airbyte [credits](https://airbyte.com/pricing) are by default assigned per works ## Managing User Roles -Airbyte offers multiple user roles to enable teams to securely access workspaces or organizations. Some roles are only available to certain products. +Airbyte offers multiple user roles to enable teams to securely access workspaces or organizations. All roles are available to Cloud Teams and Self-Managed Enterprise users. Cloud users only have admin roles. | Role | Cloud | Cloud Teams | Enterprise | | ----------------------------------------------------------------------------------------------------------------------- | ----- | ----------- | ---------- | -| **Organization Admin:** Administer the whole organization, create workspaces in it, and manage organization permissions | | ✅ | ✅ | -| **Workspace Admin:** Administer the workspace, create workspace permissions | ✅ | | | +| **Organization Admin:** Administer the whole organization, create workspaces in it, and manage organization permissions | ✅ | ✅ | ✅ | +| **Workspace Admin:** Administer the workspace, create workspace permissions | ✅ | ✅ | ✅ | | **Workspace Reader:** View information within a workspace, cannot modify anything within a workspace | | ✅ | ✅ | + +More information about specific roles can be found in our [Role-Based Access Control documentation](../access-management/rbac.md). + ## Switch between multiple workspaces To switch between workspaces, click the current workspace name under the Airbyte logo in the navigation bar. Search for the workspace or click the name of the workspace you want to switch to.