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

The Storage API from Keboola — 64 operation(s) for storage.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 68 operations across 64 paths, and defines 8 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.

68 operations 64 paths 8 schemas 13 DELETE20 GET28 POST7 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 Storage API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-StorageApi-Token (ApiKeyAuth).

Paths & Operations 68

Across 64 paths, the API surfaces 68 operations — 13 DELETE, 20 GET, 28 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

Storage 68
GET
/v2/storage/branch/{branchId}/buckets/{bucketId}/metadata
get_/v2/storage/branch/{branchId}/buckets/{bucketId}/metadata::BucketMetadataAction 2 params → default
GET
/v2/storage/buckets/{bucketId}/metadata
get_/v2/storage/buckets/{bucketId}/metadata::BucketMetadataAction 1 param → default
POST
/v2/storage/branch/{branchId}/buckets/{bucketId}/refresh-tables-info
post_/v2/storage/branch/{branchId}/buckets/{bucketId}/refresh-tables-info::RefreshTablesInformationAction 2 params → default
POST
/v2/storage/branch/{branchId}/buckets/register
post_/v2/storage/branch/{branchId}/buckets/register::RegisterExistingBucketAction 1 param → default
POST
/v2/storage/buckets/register
post_/v2/storage/buckets/register::RegisterExistingBucketAction → default
POST
/v2/storage/branch/{branchId}/buckets/{bucketId}/scheduled-tasks/refresh
post_/v2/storage/branch/{branchId}/buckets/{bucketId}/scheduled-tasks/refresh::ScheduleRefreshAction 2 params body → default
POST
/v2/storage/buckets/{bucketId}/scheduled-tasks/refresh
post_/v2/storage/buckets/{bucketId}/scheduled-tasks/refresh::ScheduleRefreshAction 1 param body → default
PUT
/v2/storage/branch/{branchId}/buckets/{bucketId}/share
put_/v2/storage/branch/{branchId}/buckets/{bucketId}/share::BucketShareUpdateAction 2 params → default
PUT
/v2/storage/buckets/{bucketId}/share
put_/v2/storage/buckets/{bucketId}/share::BucketShareUpdateAction 1 param → default
POST
/v2/storage/branch/{branchId}/buckets/{bucketId}/share-to-projects
post_/v2/storage/branch/{branchId}/buckets/{bucketId}/share-to-projects::BucketShareToProjectsAction 2 params → default
POST
/v2/storage/buckets/{bucketId}/share-to-projects
post_/v2/storage/buckets/{bucketId}/share-to-projects::BucketShareToProjectsAction 1 param → default
POST
/v2/storage/branch/{branchId}/buckets/{bucketId}/share-to-users
post_/v2/storage/branch/{branchId}/buckets/{bucketId}/share-to-users::BucketShareToUsersAction 2 params → default
POST
/v2/storage/buckets/{bucketId}/share-to-users
post_/v2/storage/buckets/{bucketId}/share-to-users::BucketShareToUsersAction 1 param → default
GET
/v2/storage/branch/{branchId}/components
get_/v2/storage/branch/{branchId}/components::ComponentsListAction 1 param → default
GET
/v2/storage/components
get_/v2/storage/components::ComponentsListAction → default
DELETE
/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}
delete_/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}::ConfigurationDeleteAction 3 params → default
DELETE
/v2/storage/components/{componentId}/configs/{configurationId}
delete_/v2/storage/components/{componentId}/configs/{configurationId}::ConfigurationDeleteAction 2 params → default
POST
/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/restore
post_/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/restore::ConfigurationRestoreAction 3 params → default
POST
/v2/storage/components/{componentId}/configs/{configurationId}/restore
post_/v2/storage/components/{componentId}/configs/{configurationId}/restore::ConfigurationRestoreAction 2 params → default
GET
/v2/storage/dev-branches/{id}
get_/v2/storage/dev-branches/{id}::DevBranchDetailAction 1 param → default
PUT
/v2/storage/dev-branches/{id}
put_/v2/storage/dev-branches/{id}::DevBranchUpdateAction 1 param body → default
DELETE
/v2/storage/dev-branches/{id}
delete_/v2/storage/dev-branches/{id}::DevBranchDeleteAction 1 param → default
POST
/v2/storage/dev-branches/
post_/v2/storage/dev-branches/::DevBranchCreateAction → default
GET
/v2/storage/dev-branches
get_/v2/storage/dev-branches::DevBranchesListAction → default
POST
/v2/storage/dev-branches
post_/v2/storage/dev-branches::DevBranchCreateAction → default
POST
/v2/storage/branch/{branchId}/files/{fileId}/tags
post_/v2/storage/branch/{branchId}/files/{fileId}/tags::FileCreateTagAction 2 params body → default
POST
/v2/storage/files/{fileId}/tags
post_/v2/storage/files/{fileId}/tags::FileCreateTagAction 1 param body → default
GET
/v2/storage/branch/{branchId}/files/{fileId}
get_/v2/storage/branch/{branchId}/files/{fileId}::FileDetailAction 3 params → default
GET
/v2/storage/files/{fileId}
get_/v2/storage/files/{fileId}::FileDetailAction 2 params → default
DELETE
/v2/storage/branch/{branchId}/files/{fileId}/tags/{tagName}
delete_/v2/storage/branch/{branchId}/files/{fileId}/tags/{tagName}::FileDeleteTagAction 3 params → default
DELETE
/v2/storage/files/{fileId}/tags/{tagName}
delete_/v2/storage/files/{fileId}/tags/{tagName}::FileDeleteTagAction 2 params → default
GET
/v2/storage/branch/{branchId}/files
get_/v2/storage/branch/{branchId}/files::FileListAction 1 param body → default
GET
/v2/storage/files
get_/v2/storage/files::FileListAction body → default
POST
/v2/storage/branch/{branchId}/files/prepare
post_/v2/storage/branch/{branchId}/files/prepare::FilePrepareAction 1 param → default
POST
/v2/storage/files/prepare
post_/v2/storage/files/prepare::FilePrepareAction → default
PUT
/v2/storage/branch/{branchId}/files/{fileId}/refresh
put_/v2/storage/branch/{branchId}/files/{fileId}/refresh::RefreshAction 2 params → default
PUT
/v2/storage/files/{fileId}/refresh
put_/v2/storage/files/{fileId}/refresh::RefreshAction 1 param → default
GET
/v2/storage/global-search
get_/v2/storage/global-search::SearchAction → default
GET
/v2/storage/jobs/{jobId}
get_/v2/storage/jobs/{jobId}::JobDetailAction 1 param → default
DELETE
/v2/storage/scheduled-tasks/{taskId}
delete_/v2/storage/scheduled-tasks/{taskId}::ScheduledTaskDeleteAction 1 param → default
GET
/v2/storage/snapshots/{snapshotId}
get_/v2/storage/snapshots/{snapshotId}::SnapshotDetailAction 1 param → default
DELETE
/v2/storage/snapshots/{snapshotId}
delete_/v2/storage/snapshots/{snapshotId}::SnapshotDeleteAction 1 param → default
GET
/v2/storage/stats
get_/v2/storage/stats::StatsListAction → default
GET
/v2/storage
Storage API index
get_/v2/storage::StorageIndexAction → 200
PUT
/v2/storage/branch/{branchId}/tables/{id}/columns/{column}/definition
put_/v2/storage/branch/{branchId}/tables/{id}/columns/{column}/definition::DefinitionUpdateAction 3 params → default
PUT
/v2/storage/tables/{id}/columns/{column}/definition
put_/v2/storage/tables/{id}/columns/{column}/definition::DefinitionUpdateAction 2 params → default
DELETE
/v2/storage/branch/{branchId}/tables/{id}/rows
delete_/v2/storage/branch/{branchId}/tables/{id}/rows::DeleteRowsAction 3 params → default
DELETE
/v2/storage/tables/{id}/rows
delete_/v2/storage/tables/{id}/rows::DeleteRowsAction 2 params → default
POST
/v2/storage/branch/{branchId}/tables/{id}/import-async
post_/v2/storage/branch/{branchId}/tables/{id}/import-async::ImportAsyncAction 3 params body → default
POST
/v2/storage/tables/{id}/import-async
post_/v2/storage/tables/{id}/import-async::ImportAsyncAction 2 params body → default
POST
/v2/storage/branch/{branchId}/tables/{tableId}/profile
post_/v2/storage/branch/{branchId}/tables/{tableId}/profile::ProfileCreateAction 2 params → default
POST
/v2/storage/tables/{tableId}/profile
post_/v2/storage/tables/{tableId}/profile::ProfileCreateAction 1 param → default
GET
/v2/storage/branch/{branchId}/tables/{tableId}/profile/{uuid}
get_/v2/storage/branch/{branchId}/tables/{tableId}/profile/{uuid}::ProfileDetailAction 3 params → default
GET
/v2/storage/tables/{tableId}/profile/{uuid}
get_/v2/storage/tables/{tableId}/profile/{uuid}::ProfileDetailAction 2 params → default
POST
/v2/storage/branch/{branchId}/tables/{id}/pull
post_/v2/storage/branch/{branchId}/tables/{id}/pull::PullAction 2 params → default
DELETE
/v2/storage/branch/{branchId}/tables/{id}
delete_/v2/storage/branch/{branchId}/tables/{id}::TableDeleteAction 4 params → default
DELETE
/v2/storage/tables/{id}
delete_/v2/storage/tables/{id}::TableDeleteAction 3 params → default
GET
/v2/storage/branch/{branchId}/tables
get_/v2/storage/branch/{branchId}/tables::TablesListAction 1 param → default
GET
/v2/storage/tables
get_/v2/storage/tables::TablesListAction → default
DELETE
/v2/storage/branch/{branchId}/workspaces/{workspaceId}
delete_/v2/storage/branch/{branchId}/workspaces/{workspaceId}::WorkspaceDeleteAction 4 params → default
DELETE
/v2/storage/workspaces/{workspaceId}
delete_/v2/storage/workspaces/{workspaceId}::WorkspaceDeleteAction 3 params → default
POST
/v2/storage/branch/{branchId}/workspaces/{workspaceId}/load
post_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/load::WorkspaceLoadAction 2 params body → default
POST
/v2/storage/workspaces/{workspaceId}/load
post_/v2/storage/workspaces/{workspaceId}/load::WorkspaceLoadAction 1 param body → default
POST
/v2/storage/branch/{branchId}/workspaces/{workspaceId}/password
post_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/password::WorkspacePasswordAction 2 params → default
POST
/v2/storage/workspaces/{workspaceId}/password
post_/v2/storage/workspaces/{workspaceId}/password::WorkspacePasswordAction 1 param → default
GET
/v2/storage/branch/{branchId}/workspaces/{workspaceId}/saml2-login
get_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/saml2-login::WorkspaceSsoInitializeAction 2 params → default
POST
/v2/storage/branch/{branchId}/workspaces/{workspaceId}/load-clone
post_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/load-clone::WorkspacesLoadCloneAction 2 params body → default
POST
/v2/storage/workspaces/{workspaceId}/load-clone
post_/v2/storage/workspaces/{workspaceId}/load-clone::WorkspacesLoadCloneAction 1 param body → default

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ImportDataAsyncFromWorkspaceRequest (10 properties), ImportDataAsyncFromFileRequest (9 properties), BackendConfigurationRequest (1 property). Each schema is shown below with its type and property counts.

ScheduleRefreshRequest
object
ListFilesRequest
object
BackendConfigurationRequest
object
1 property
ImportDataAsyncFromFileRequest
object
9 properties 6 required
ImportDataAsyncFromWorkspaceRequest
object
10 properties 8 required
CreateTagRequest
object
UpdateDevBranchRequest
object
CloneLoadRequest
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keboola-storage-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
#Storage
← Back to K APIs
API Details
ID
keboola:keboola-storage-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