Airbyte Configuration API

Airbyte Configuration API

Airbyte Configuration API allows users to manage and automate the setup of data integrations, including source and destination configurations for data pipelines.
Subscribe 
                  {
  "jobSpecific": [
    {
      "jobType": "sync",
      "resourceRequirements": {
        "cpu_limit": "0.5",
        "cpu_request": "0.5",
        "memory_limit": "500Mi",
        "memory_request": "500Mi"
      }
    }
  ]
}

Response example. If you want to see more check the documentation.

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.

  • 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/{VERSION}/{METHOD_FAMILY}/{METHOD_NAME} e.g. `localhost:8000/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=="`