1. Home
2. Keboola Overview
3. Our APIs

Our APIs

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

All our Keboola components have a public API on apiary. We recommend using either the Apiary Console or Postman Client for sending requests to our API. Most of our APIs accept and return data in JSON format. Many of these APIs require a Storage API token, specified in the X-StorageApi-Token header.

List of Keboola APIs

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

If you’re unsure which API to use, refer to our integration guide. It describes the roles of different APIs and contains examples of commonly performed actions.

Stacks and Endpoints

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

• US Virginia AWS – connection.keboola.com
• US Virginia GCP - connection.us-east4.gcp.keboola.com
• EU Frankfurt AWS – connection.eu-central-1.keboola.com
• EU Ireland Azure – connection.north-europe.azure.keboola.com
• EU Frankfurt GCP - connection.europe-west3.gcp.keboola.com

Each stack operates as an independent instance of Keboola 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 the format connection.CUSTOMER_NAME.keboola.com.

If you are using another stack, modify the endpoints accordingly. Otherwise, you may encounter 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": "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
• 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 stack also uses its own set of IP addresses.

Calling API

There are several ways to send requests to our APIs:

Apiary Console

Send requests to our API directly from the Apiary console by clicking on Switch to console or Try. Fill in the request headers and parameters, then click 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, suitable for more regular API work. 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 with a command-line interface (CLI). You can use the cURL CLI to create simple scripts for interacting with Keboola APIs. For example, to run a job:

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