1. Home
2. KBC Overview
3. Our APIs

Our APIs

• List of Keboola APIs
• Stacks and Endpoints
• Calling API
  • Apiary Console
  • Postman Client
  • cURL

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 X-StorageApi-Token header.

List of Keboola APIs

All parts of the Keboola Connection platform can be controlled via an API. The main APIs for our components are:

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.

Stacks and Endpoints

Keboola Connection is available in multiple stacks. These can be either multi-tenant or single-tenant. Current multi-tenant stacks are:

• US AWS – connection.keboola.com,
• EU AWS – connection.eu-central-1.keboola.com,
• EU Azure – connection.north-europe.azure.keboola.com.

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 in form connection.CUSTOMER_NAME.keboola.com.

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:

{
    ...,
  "services": [
        {
            "id": "docker-runner",
            "url": "https://docker-runner.keboola.com"
        },
        {
            "id": "import",
            "url": "https://import.keboola.com"
        },
        {
            "id": "syrup",
            "url": "https://syrup.keboola.com"
        },
        {
            "id": "oauth",
            "url": "https://oauth.keboola.com"
        },
        {
            "id": "queue",
            "url": "https://queue.keboola.com"
        },
        {
            "id": "billing",
            "url": "https://billing.keboola.com"
        },
        {
            "id": "encryption",
            "url": "https://encryption.keboola.com"
        },
        {
            "id": "sandboxes",
            "url": "https://sandboxes.keboola.com"
        },
        {
            "id": "mlflow",
            "url": "https://mlflow.keboola.com"
        },
        {
            "id": "spark",
            "url": "https://spark.keboola.com"
        },
        {
            "id": "scheduler",
            "url": "https://scheduler.keboola.com"
        },
        {
            "id": "sync-actions",
            "url": "https://sync-actions.keboola.com"
        },
        {
            "id": "notification",
            "url": "https://notification.keboola.com"
        },
        {
            "id": "templates",
            "url": "https://templates.keboola.com"
        }
    ],
}

The services listed above are:

• docker-runner — Legacy Service for Running Sync Actions
• import — Storage Importer Service
• syrup — Service for Running Components
• oauth — OAuth Manager Service
• queue — Service for Running Components
• billing — Service for Computing Credits
• encryption — Service for Encryption.
• sandboxes — Workspace Manager Service
• mlflow — MLFlow Models Manager Service
• scheduler — Service for Configuring Schedules
• sync-actions — Service for Running Synchronous Actions
• notification — Service for Configuring Job Notifications
• templates — Service for Applying Templates

For convenience, the following table lists active services and their URLs, though for an authoritative answer and in application integrations, we strongly suggest using the above API call.

Important: Each of the stacks also uses its own set of IP addresses.

Calling API

There are several ways of sending requests to our APIs.

Apiary Console

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 Client

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

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

curl --data "{\"config\": \"sampledatabase\"}" --header "X-StorageAPI-Token: YourStorageToken" https://syrup.keboola.com/keboola.ex-db-mysql/run