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 SQL Editor API

The SQL Editor API from Keboola — 13 operation(s) for sql editor.

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

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

This API exposes 15 operations across 13 paths, and defines 21 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.

15 operations 13 paths 21 schemas 1 DELETE5 GET9 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 SQL Editor API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-StorageApi-Token (ApiKeyAuth).

Paths & Operations 15

Across 13 paths, the API surfaces 15 operations — 1 DELETE, 5 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

SQL Editor 15
POST
/sql/sessions
Create a new SQL Editor session
createSqlEditorSession body → 201default
GET
/sql/sessions
List SQL Editor sessions
listSqlEditorSessions 2 params → 200default
GET
/sql/sessions/{id}
Get a SQL Editor session by ID
getSqlEditorSession 1 param → 200default
DELETE
/sql/sessions/{id}
Delete a SQL Editor session
deleteSqlEditorSession 1 param → 204default
GET
/sql/sessions/{id}/credentials
Get workspace credentials for a SQL Editor session
getSqlEditorSessionCredentials 1 param → 200400404default
POST
/sql/sessions/{id}/load
Load data into SQL Editor session
loadSqlEditorSession 1 param body → 200default
POST
/sql/sessions/{id}/unload
Unload data from SQL Editor session workspace
unloadSqlEditorSession 1 param body → 200default
POST
/sql/sessions/{id}/reset-credentials
Reset workspace credentials
resetSqlEditorSessionCredentials 1 param → 200400404default
POST
/sql/sessions/{id}/reset-password
Reset workspace password (deprecated)
resetSqlEditorSessionPassword 1 param → 200400404default
POST
/sql/sessions/{id}/acknowledge-last-error
Acknowledge session error
acknowledgeSessionError 1 param → 200400404default
GET
/sql/sessions/{id}/schema
Get SQL Editor session schema
getSqlEditorSessionSchema 3 params → 200default
POST
/sql/get-output-tables
Retrieve output tables from SQL queries
getSqlEditorOutputTables body → 200default
POST
/sql/sessions/{id}/run-query
Run SQL queries in SQL Editor session
runSqlEditorQuery 1 param body → 200default
POST
/sql/sessions/{id}/table-preview
Get table preview in SQL Editor session
getTablePreview 1 param body → 200default
GET
/sql/sessions/{id}/table-ddl
Get table DDL (CREATE TABLE statement)
getTableDDL 4 params → 200default

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are SqlEditorSession (21 properties), Table (7 properties), ResetPasswordResponse (6 properties), Schema (4 properties). Each schema is shown below with its type and property counts.

CreateSqlEditorSessionRequest
object
4 properties 3 required
TableDefinitions
object
1 property 1 required
TableDDLResponse
object
1 property 1 required
TablePreviewRequest
object
3 properties 1 required
Catalog
object
3 properties 2 required
TableMetrics
object
2 properties
SqlEditorSession
object
21 properties 13 required
ResetCredentialsResponse
object
2 properties 2 required
Schema
object
4 properties 3 required
TablePreviewResponse
object
2 properties 2 required
RunQueryRequest
object
1 property 1 required
ResetPasswordResponse
object
6 properties 6 required
TableLifecycle
object
3 properties
Column
object
2 properties 1 required
GetOutputTablesRequest
object
1 property 1 required
Table
object
7 properties 3 required
RunQueryResponse
object
2 properties 2 required
UnloadSessionRequest
object
1 property
Error
object
4 properties 3 required
GetOutputTablesResponse
object
1 property 1 required
LoadSessionRequest
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keboola-sql-editor-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