All our KBC components have a public API on apiary. For sending requests to our
API, we recommend either the Apiary Console or Postman Client. Most of our APIs take and produce data in JSON format.
Many of them require a Storage API token, which is entered in the
All parts of the Keboola Connection platform can be controlled via an API. The main APIs for our components are:
|KBC Storage API||Storage is the main KBC component storing all data.|
|KBC Management API||API managing KBC projects and users (and notifications and features).|
|Encryption API||Provides Encryption.|
|Docker Runner API||Docker Runner is the component running other KBC components.|
|JSON Parser API||JSON Parser is a service converting JSON files to CSV.|
|Transformation API||Transformations is the component running SQL/R/Python transformations.|
|Provisioning API||Provisioning is a service creating accounts for sandboxes, transformations and database writers.|
|Provisioning Management API||API managing servers for sandboxes, transformations.|
|Syrup Queue API||Syrup Queue is a component managing Jobs. Being replaced by Queue API.|
|Queue API||Queue is a service for running components and managing Jobs.|
|OAuth Broker API||OAuth Broker is a component managing OAuth authorizations of other components.|
|Orchestrator API||Orchestrator is a component automating and scheduling tasks in your project.|
|Importer API||Importer is a helper service for easy table imports|
|Developer Portal API||Developer Portal is an application separated from KBC for creating components.|
|Billing API||Billing API for Pay as You Go projects.|
|Workspaces API||Workspaces API for V2 workspaces.|
|Synchronous Actions API||API to trigger Synchronous Actions. This is a partial replacement of Docker Runner API and may not be available on all stacks.|
|Scheduler API||API to automate configurations (replacement for Orchestrator API)|
|Notifications API||API to subscribe to events - e.g. failed orchestrations (replacement for Orchestrator API)|
If you don’t know which API to use, see our integration guide. It describes different roles of the APIs and contains examples of commonly performed actions.
Keboola Connection is available in multiple stacks. These can be either multi-tenant or single-tenant. Current multi-tenant stacks are:
Each stack is a completely independent instance of Keboola Connection services. In all the API documentation above, the AWS US stack is used.
Single-tenant stacks are available for a single enterprise customer with a domain name
If you are using another stack, modify the endpoints accordingly.
Otherwise you will obtain an
Invalid Token or unauthorized errors. The authoritative list of available endpoints is provided by the Storage API Index Call. The following is a sample response:
The services listed above are:
docker-runner— Legacy Service for Running Sync Actions
import— Storage Importer Service
syrup— Service for Running Components
queue— New Service for Running Components
oauth— OAuth Manager Service
sqldep-analyzer— SQLdep Integration Service for SQL query validation.
sync-actions— Service for Running Synchronous Actions
graph— Service for generating project lineage and graphs.
encryption— Service for encryption.
Important: Each of the stacks also uses its own set of IP addresses.
There are several ways of sending requests to our APIs.
Send requests to our API directly from the Apiary console by clicking on Switch to console or Try. Then fill the request headers and parameters and Call Resource.
The Apiary console is fine if you send API requests only occasionally. It requires no application installation; however, it has no history and no other useful features.
Postman is a generic HTTP API client. Use it if you work with KBC APIs on a more regular basis. We also provide a collection of useful API calls with examples. The collection contains code examples in various languages; the requests can also be imported into the Postman application.
cURL is a common library used by many systems. There is also a command-line interface (CLI) available. You can use the cURL CLI to create simple scripts working with KBC APIs. For example, to Run a Job, use