providers/airbyte/docs/connections.rst
.. Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
.. http://www.apache.org/licenses/LICENSE-2.0
.. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
.. _howto/connection:airbyte:
The Airbyte connection type use the Airbyte API Python SDK to authenticate to the server.
Host(required)
The full qualified host domain to connect to the Airbyte server.
If you are using Airbyte Cloud: https://api.airbyte.com/v1/
If you are using Airbyte OSS: http://localhost:8000/api/public/v1/
Be aware: If you're changing the API path, you must update the value accordingly.
Token URL (optional)
The prefix for URL used to create the access token.
If you are using Airbyte Cloud: v1/applications/token (default value)
If you are using Airbyte OSS: ``/api/public/v1/applications/token```
Be aware: If you're changing the API path, you must update the value accordingly.
Client ID (required) The Client ID to connect to the Airbyte server. You can find this information in the Settings / Applications page in Airbyte UI.
Client Secret (required) The Client Secret to connect to the Airbyte server. You can find this information in the Settings / Applications page in Airbyte UI.
Extra (optional) Specify custom proxies in json format. Following default requests parameters are taken into account:
* ``proxies``
Example: ``{"http": "http://proxy.example.com:8080", "https": "http://proxy.example.com:8080"}``