Keboola configuration API

The configuration API from Keboola — 26 operation(s) for configuration.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 34 operations across 26 paths. 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.

34 operations 26 paths 0 schemas 4 DELETE15 GET4 PATCH3 POST8 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

Authentication & Security 1

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

Paths & Operations 34

Across 26 paths, the API surfaces 34 operations — 4 DELETE, 15 GET, 4 PATCH, 3 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

configuration 34

GET

/v1/branches/{branchId}/sources

List all sources

ListSources 3 params → 200

POST

/v1/branches/{branchId}/sources

Create source

CreateSource 1 param body → 202409422

GET

/v1/branches/{branchId}/sources/{sourceId}

Get source

GetSource 2 params → 200404

DELETE

/v1/branches/{branchId}/sources/{sourceId}

Delete source

DeleteSource 3 params → 202404

PATCH

/v1/branches/{branchId}/sources/{sourceId}

Update source

UpdateSource 2 params body → 202404

PUT

/v1/branches/{branchId}/sources/{sourceId}/disable

Disable source

DisableSource 2 params → 202404

PUT

/v1/branches/{branchId}/sources/{sourceId}/enable

Enable source

EnableSource 2 params → 202404

POST

/v1/branches/{branchId}/sources/{sourceId}/rotate-secret

Rotate source secret

RotateSourceSecret 2 params → 200404

GET

/v1/branches/{branchId}/sources/{sourceId}/settings

Get source settings

GetSourceSettings 2 params → 200404

PATCH

/v1/branches/{branchId}/sources/{sourceId}/settings

Update source settings

UpdateSourceSettings 2 params body → 202404

GET

/v1/branches/{branchId}/sources/{sourceId}/sinks

List sinks

ListSinks 4 params → 200404

POST

/v1/branches/{branchId}/sources/{sourceId}/sinks

Create sink

CreateSink 2 params body → 202404409422

GET

/v1/branches/{branchId}/sources/{sourceId}/sinks/{sinkId}

Get sink

GetSink 3 params → 200404

DELETE

/v1/branches/{branchId}/sources/{sourceId}/sinks/{sinkId}

Delete sink

DeleteSink 3 params → 202404

PATCH

/v1/branches/{branchId}/sources/{sourceId}/sinks/{sinkId}

Update sink

UpdateSink 3 params body → 202404

PUT

/v1/branches/{branchId}/sources/{sourceId}/sinks/{sinkId}/disable

Disable sink

DisableSink 3 params → 202404

PUT

/v1/branches/{branchId}/sources/{sourceId}/sinks/{sinkId}/enable

Enable sink

EnableSink 3 params → 202404

GET

/v1/branches/{branchId}/sources/{sourceId}/sinks/{sinkId}/settings

Get sink settings

GetSinkSettings 3 params → 200404

PATCH

/v1/branches/{branchId}/sources/{sourceId}/sinks/{sinkId}/settings

Update sink settings

UpdateSinkSettings 3 params body → 202404

DELETE

/v1/branches/{branchId}/sources/{sourceId}/sinks/{sinkId}/statistics/clear

Clear sink statistics

SinkStatisticsClear 3 params → 200404

GET

/v1/branches/{branchId}/sources/{sourceId}/sinks/{sinkId}/statistics/files

Sink files statistics

SinkStatisticsFiles 4 params → 200404

GET

/v1/branches/{branchId}/sources/{sourceId}/sinks/{sinkId}/statistics/total

Sink statistics total

SinkStatisticsTotal 3 params → 200404

PUT

/v1/branches/{branchId}/sources/{sourceId}/sinks/{sinkId}/undelete

Undelete sink

UndeleteSink 3 params → 202404

GET

/v1/branches/{branchId}/sources/{sourceId}/sinks/{sinkId}/versions

List sink versions

ListSinkVersions 5 params → 200404

GET

/v1/branches/{branchId}/sources/{sourceId}/sinks/{sinkId}/versions/{versionNumber}

Sink version detail

SinkVersionDetail 4 params → 200404

PUT

/v1/branches/{branchId}/sources/{sourceId}/sinks/{sinkId}/versions/{versionNumber}/rollback

Rollback sink version

RollbackSinkVersion 4 params → 202404

GET

/v1/branches/{branchId}/sources/{sourceId}/sinks/deleted

List deleted sinks

ListDeletedSinks 4 params → 200404

DELETE

/v1/branches/{branchId}/sources/{sourceId}/statistics/clear

Clear source statistics

SourceStatisticsClear 2 params → 200404

PUT

/v1/branches/{branchId}/sources/{sourceId}/undelete

Undelete source

UndeleteSource 2 params → 202404

GET

/v1/branches/{branchId}/sources/{sourceId}/versions

List source versions

ListSourceVersions 4 params → 200404

GET

/v1/branches/{branchId}/sources/{sourceId}/versions/{versionNumber}

Source version detail

SourceVersionDetail 3 params → 200404

PUT

/v1/branches/{branchId}/sources/{sourceId}/versions/{versionNumber}/rollback

Rollback source version

RollbackSourceVersion 3 params → 202404

GET

/v1/branches/{branchId}/sources/deleted

List all deleted sources

ListDeletedSources 3 params → 200

GET

/v1/tasks/{taskId}

Get task

GetTask 1 param → 200404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

#configuration

← Back to K APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Keboola configuration API

Metadata

Authentication & Security 1

Paths & Operations 34

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Keboola configuration API

Metadata

Authentication & Security 1

Paths & Operations 34

Specification

Source

More from Keboola 12

API Details

Provider

Explore more