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 Documentation API

The Documentation API from Keboola — 9 operation(s) for documentation.

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

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

This API exposes 9 operations across 9 paths, and defines 4 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.

9 operations 9 paths 4 schemas 8 GET1 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 Documentation API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-StorageApi-Token (ApiKeyAuth).

Paths & Operations 9

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

Documentation 9
POST
/docs/question
Ask a documentation question
askDocsQuestion body → 201default
GET
/docs/components/{componentId}
Get component documentation
getComponentDocs 1 param → 200default
GET
/api/v1/documentation
API Documentation
→ 200
GET
/
Redirect to /v1
ApiRootIndex → 301
GET
/v1
List API name and link to documentation.
ApiVersionIndex → 200
GET
/v1/documentation/openapi.json
Swagger 2.0 JSON Specification
OpenapiJson → 200
GET
/v1/documentation/openapi.yaml
Swagger 2.0 YAML Specification
OpenapiYaml → 200
GET
/v1/documentation/openapi3.json
OpenAPI 3.0 JSON Specification
Openapi3Json → 200
GET
/v1/documentation/openapi3.yaml
OpenAPI 3.0 YAML Specification
Openapi3Yaml → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ComponentDocsResponse (15 properties), Error (4 properties), DocsResponse (2 properties), AskDocsQuestionRequest (1 property). Each schema is shown below with its type and property counts.

DocsResponse
object
2 properties 2 required
AskDocsQuestionRequest
object
1 property 1 required
ComponentDocsResponse
object
15 properties 14 required
Error
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keboola-documentation-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