Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Keboola Data Apps API

The Data Apps API from Keboola — 14 operation(s) for data apps.

Keboola Data Apps API is one of 79 APIs that Keboola publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Data Apps. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 19 operations across 14 paths, and defines 6 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against the base URL https://connection.keboola.com/v2/storage.

19 operations 14 paths 6 schemas 2 DELETE13 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://connection.keboola.com/v2/storage
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Keboola Data Apps API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-StorageApi-Token (ApiKeyAuth).

Paths & Operations 19

Across 14 paths, the API surfaces 19 operations — 2 DELETE, 13 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Data Apps 19
GET
/apps
List apps
listApps 5 params → 200401403
POST
/apps
Create app
createApp body → 200401422
GET
/apps/{appId}
Get app detail
getApp 1 param → 200401403404
PATCH
/apps/{appId}
Update app state
patchApp 1 param body → 200401403404409422
DELETE
/apps/{appId}
Delete app
deleteApp 1 param → 202401403404
GET
/apps/{appId}/proxy-config
Get proxy config for the app
getAppProxyConfig 2 params → 200304401403404
GET
/apps/{appId}/password
Get app password
getAppPassword 1 param → 200401403404
POST
/apps/{appId}/reset-password
Reset app password
resetAppPassword 1 param → 200401403404
GET
/apps/{appId}/git-repo
Get details of the app's configured Git repository
getAppGitRepo 1 param → 200401403404409
GET
/apps/{appId}/git-repo/branches
List branches of the app's configured Git repository
listAppGitRepoBranches 1 param → 200401403404409
GET
/apps/{appId}/git-repo/entrypoints
List entrypoint files in the app's configured Git repository
listAppGitRepoEntrypoints 1 param → 200401403404409
POST
/apps/{appId}/git-repo/credentials
Create credential for managed Git repository
createAppGitRepoCredential 1 param body → 201400401403404409
GET
/apps/{appId}/git-repo/credentials
List credentials for managed Git repository
listAppGitRepoCredentials 1 param → 200401403404
GET
/apps/{appId}/git-repo/credentials/{credentialId}
Get credential detail
getAppGitRepoCredential 2 params → 200401403404
DELETE
/apps/{appId}/git-repo/credentials/{credentialId}
Revoke and remove a credential
deleteAppGitRepoCredential 2 params → 204401403404
GET
/apps/{appId}/logs/download
Download app logs
downloadAppLogs 1 param → 200401403404
GET
/apps/{appId}/logs/tail
Tail app logs
tailAppLogs 3 params → 200401403404
GET
/apps/{appId}/runs
List app runs
listAppRuns 3 params → 200401403404
GET
/apps/{appId}/runs/{runId}
Get app run detail
getAppRun 2 params → 200401403404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ExistingApp (18 properties), AppRun (11 properties), Credential (6 properties), CreateCredentialRequest (4 properties). Each schema is shown below with its type and property counts.

CreateCredentialRequest
object
4 properties 2 required
Credential
object
6 properties 6 required
ExistingApp
object
18 properties 11 required
CreatedCredential
AppRun
object
11 properties 3 required
CredentialList
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keboola-data-apps-api-openapi.yml Raw ↑

Other APIs Keboola publishes across the network.

Keboola Actions API
Keboola Admin Apps API
Keboola Admin Stacks API
Keboola Admin Users API
Keboola Admin Vendors API
Keboola App API
Keboola Auth API
Keboola Authorize API
Keboola Branch metadata API
Keboola Buckets API
Keboola Columns API
Keboola Component Configuration Metadata API