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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Keboola

Keboola Component Configurations API

The Component Configurations API from Keboola — 11 operation(s) for component configurations.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 15 operations across 11 paths, and defines 5 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 11 paths 5 schemas 7 GET4 POST4 PUT

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
Contact
devel@keboola.com
License
MIT
Resource Areas
1

Authentication & Security 1

Keboola Component Configurations 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 11 paths, the API surfaces 15 operations — 7 GET, 4 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Component Configurations 15
GET
/v2/storage/branch/{branchId}/components/{componentId}/configs
List configurations
get_/v2/storage/branch/{branchId}/components/{componentId}/configs::ConfigurationListAction 3 params → 200404
POST
/v2/storage/branch/{branchId}/components/{componentId}/configs
Create configuration
post_/v2/storage/branch/{branchId}/components/{componentId}/configs::ConfigurationCreateAction 2 params body → 201404
GET
/v2/storage/components/{componentId}/configs
List configurations
get_/v2/storage/components/{componentId}/configs::ConfigurationListAction 2 params → 200404
POST
/v2/storage/components/{componentId}/configs
Create configuration
post_/v2/storage/components/{componentId}/configs::ConfigurationCreateAction 1 param body → 201404
GET
/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}
Get configuration detail
get_/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}::ConfigurationDetailAction 3 params → 200404
PUT
/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}
Update configuration
put_/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}::ConfigurationUpdateAction 3 params body → 200404
GET
/v2/storage/components/{componentId}/configs/{configurationId}
Get configuration detail
get_/v2/storage/components/{componentId}/configs/{configurationId}::ConfigurationDetailAction 2 params → 200404
PUT
/v2/storage/components/{componentId}/configs/{configurationId}
Update configuration
put_/v2/storage/components/{componentId}/configs/{configurationId}::ConfigurationUpdateAction 2 params body → 200404
GET
/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/diff
Get configuration three-way diff
get_/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/diff::ConfigurationDiffAction 3 params → 200404400
POST
/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/reset-to-default
Reset configuration to default branch
post_/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/reset-to-default::ConfigurationResetToDefaultAction 3 params → 204404501
POST
/v2/storage/components/{componentId}/configs/{configurationId}/reset-to-default
Reset configuration to default branch
post_/v2/storage/components/{componentId}/configs/{configurationId}/reset-to-default::ConfigurationResetToDefaultAction 2 params → 204404501
PUT
/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/state
Update configuration state
put_/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/state::ConfigurationStateUpdateAction 3 params body → 200404
PUT
/v2/storage/components/{componentId}/configs/{configurationId}/state
Update configuration state
put_/v2/storage/components/{componentId}/configs/{configurationId}/state::ConfigurationStateUpdateAction 2 params body → 200404
GET
/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/workspaces
List configuration workspaces
get_/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/workspaces::ConfigurationWorkspacesListAction 3 params → 200404
GET
/v2/storage/components/{componentId}/configs/{configurationId}/workspaces
List configuration workspaces
get_/v2/storage/components/{componentId}/configs/{configurationId}/workspaces::ConfigurationWorkspacesListAction 2 params → 200404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ConfigurationVersionResponse (10 properties), ConfigurationDiffResponse (3 properties). Each schema is shown below with its type and property counts.

UpdateConfigurationStateRequest
object
CreateConfigurationRequest
object
ConfigurationVersionResponse
object
10 properties 10 required
UpdateConfigurationRequest
object
ConfigurationDiffResponse
object
Three-way diff of a configuration body. Each side is a configuration version snapshot, or null when the configuration does not exist on that side. When there i…
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keboola-component-configurations-api-openapi.yml Raw ↑

Other APIs Keboola publishes across the network.

Keboola Actions API
AE Profile APIs.io
Keboola Admin Apps API
AE Profile APIs.io
Keboola Admin Stacks API
AE Profile APIs.io
Keboola Admin Users API
AE Profile APIs.io
Keboola Admin Vendors API
AE Profile APIs.io
Keboola App API
AE Profile APIs.io
Keboola Auth API
AE Profile APIs.io
Keboola Authorize API
AE Profile APIs.io
Keboola Branch metadata API
AE Profile APIs.io
Keboola Buckets API
AE Profile APIs.io
Keboola Columns API
AE Profile APIs.io
Keboola Component Configuration Metadata API
AE Profile APIs.io
#Component Configurations
← Back to K APIs
API Details
ID
keboola:keboola-component-configurations-api
Base URL
https://connection.keboola.com/v2/storage
Docs
https://api.keboola.com/?service=storage
Provider
Keboola
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network