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

The Workspaces API from Keboola — 24 operation(s) for workspaces.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 28 operations across 24 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.

28 operations 24 paths 21 schemas 2 DELETE8 GET18 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
Contact
devel@keboola.com
License
MIT
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 28

Across 24 paths, the API surfaces 28 operations — 2 DELETE, 8 GET, 18 POST. Each is listed below with its method, path, parameters, and response codes.

Workspaces 28
POST
/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/workspaces
Create workspace
post_/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/workspaces::WorkspaceCreateAction 5 params body → 201202400404501
POST
/v2/storage/components/{componentId}/configs/{configurationId}/workspaces
Create workspace
post_/v2/storage/components/{componentId}/configs/{configurationId}/workspaces::WorkspaceCreateAction 4 params body → 201202400404501
POST
/v2/storage/branch/{branchId}/workspaces/{workspaceId}/public-key
Set public key for workspace
post_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/public-key::WorkspacesSetPublicKeyAction 2 params → 200404400
POST
/v2/storage/workspaces/{workspaceId}/public-key
Set public key for workspace
post_/v2/storage/workspaces/{workspaceId}/public-key::WorkspacesSetPublicKeyAction 1 param → 200404400
POST
/v2/storage/branch/{branchId}/workspaces/{workspaceId}/public-key/{keyName}
Set public key for workspace
post_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/public-key/{keyName}::WorkspacesSetPublicKeyAction 3 params → 200404400
POST
/v2/storage/workspaces/{workspaceId}/public-key/{keyName}
Set public key for workspace
post_/v2/storage/workspaces/{workspaceId}/public-key/{keyName}::WorkspacesSetPublicKeyAction 2 params → 200404400
POST
/v2/storage/branch/{branchId}/workspaces/{workspaceId}/objects/batch-delete
Batch delete workspace objects
post_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/objects/batch-delete::ObjectBatchDeleteAction 2 params body → 202404
POST
/v2/storage/workspaces/{workspaceId}/objects/batch-delete
Batch delete workspace objects
post_/v2/storage/workspaces/{workspaceId}/objects/batch-delete::ObjectBatchDeleteAction 1 param body → 202404
GET
/v2/storage/branch/{branchId}/workspaces/{workspaceId}/objects
List workspace objects
get_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/objects::ObjectListAction 2 params → 200404422
GET
/v2/storage/workspaces/{workspaceId}/objects
List workspace objects
get_/v2/storage/workspaces/{workspaceId}/objects::ObjectListAction 1 param → 200404422
GET
/v2/storage/branch/{branchId}/workspaces
List workspaces
get_/v2/storage/branch/{branchId}/workspaces::WorkspacesListAction 1 param → 200
POST
/v2/storage/branch/{branchId}/workspaces
Create workspace
post_/v2/storage/branch/{branchId}/workspaces::WorkspaceCreateAction 5 params body → 201202400404501
GET
/v2/storage/workspaces
List workspaces
get_/v2/storage/workspaces::WorkspacesListAction → 200
POST
/v2/storage/workspaces
Create workspace
post_/v2/storage/workspaces::WorkspaceCreateAction 4 params body → 201202400404501
GET
/v2/storage/branch/{branchId}/workspaces/{workspaceId}
Get workspace details
get_/v2/storage/branch/{branchId}/workspaces/{workspaceId}::WorkspacesDetailAction 2 params → 200404
GET
/v2/storage/workspaces/{workspaceId}
Get workspace details
get_/v2/storage/workspaces/{workspaceId}::WorkspacesDetailAction 1 param → 200404
POST
/v2/storage/branch/{branchId}/workspaces/{workspaceId}/input-mapping-load
Load tables into a workspace using an input-mapping config
post_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/input-mapping-load::WorkspaceInputMappingLoadAction 4 params body → 200202400403404422
POST
/v2/storage/workspaces/{workspaceId}/input-mapping-load
Load tables into a workspace using an input-mapping config
post_/v2/storage/workspaces/{workspaceId}/input-mapping-load::WorkspaceInputMappingLoadAction 3 params body → 200202400403404422
POST
/v2/storage/branch/{branchId}/workspaces/{workspaceId}/credentials
Get workspace credentials
post_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/credentials::WorkspaceStorageCredentialsCreateAction 2 params → 200404400
POST
/v2/storage/workspaces/{workspaceId}/credentials
Get workspace credentials
post_/v2/storage/workspaces/{workspaceId}/credentials::WorkspaceStorageCredentialsCreateAction 1 param → 200404400
GET
/v2/storage/branch/{branchId}/workspaces/{workspaceId}/credentials/{id}
Get specific workspace credential
get_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/credentials/{id}::WorkspaceStorageCredentialsDetailAction 3 params → 200404
DELETE
/v2/storage/branch/{branchId}/workspaces/{workspaceId}/credentials/{id}
Delete workspace credential
delete_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/credentials/{id}::WorkspaceStorageCredentialsDeleteAction 3 params → 204404
GET
/v2/storage/workspaces/{workspaceId}/credentials/{id}
Get specific workspace credential
get_/v2/storage/workspaces/{workspaceId}/credentials/{id}::WorkspaceStorageCredentialsDetailAction 2 params → 200404
DELETE
/v2/storage/workspaces/{workspaceId}/credentials/{id}
Delete workspace credential
delete_/v2/storage/workspaces/{workspaceId}/credentials/{id}::WorkspaceStorageCredentialsDeleteAction 2 params → 204404
POST
/v2/storage/branch/{branchId}/workspaces/{workspaceId}/table-export
Export table from workspace
post_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/table-export::WorkspaceTableExportAction 2 params body → 404400202
POST
/v2/storage/workspaces/{workspaceId}/table-export
Export table from workspace
post_/v2/storage/workspaces/{workspaceId}/table-export::WorkspaceTableExportAction 1 param body → 404400202
POST
/v2/storage/branch/{branchId}/workspaces/{workspaceId}/unload
Unload workspace
post_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/unload::WorkspaceUnloadAction 4 params → 202400404
POST
/v2/storage/branch/{branchId}/workspaces/{workspaceId}/querydeprecated
Execute SQL query in a workspace
post_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/query::WorkspacesQueryAction 2 params body → 200400404

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are RefreshJobResponse (27 properties), TableCreateResponse (26 properties), FileDeleteResponse (14 properties), JobResponse (14 properties). Each schema is shown below with its type and property counts.

BucketListingCreateJobResult
object
4 properties 4 required
BucketListingDeleteResponse
object
14 properties 8 required
TableSnapshotCreateJobResult
object
7 properties 6 required
SourceTableResponse
object
4 properties 4 required
ObjectListResponse
object
2 properties 2 required
ExecuteQueryRequest
object
1 property 1 required
BatchDeleteRequest
object
1 property 1 required
ExecuteQueryResponse
object
3 properties 1 required
TableCreateResponse
object
26 properties 22 required
RefreshJobResponse
object
27 properties 18 required
WorkspaceDetailResponseWithSecret
object
13 properties 7 required
FileDeleteResponse
object
14 properties 8 required
WorkspaceTableExportRequest
object
Request object for exporting a table from a workspace.
4 properties 2 required
CreateWorkspaceRequest
object
8 properties
JobResponse
object
Response object for an asynchronous storage job.
14 properties 10 required
TableSwapResult
object
2 properties 2 required
TableExportJobResponse
object
1 property
InputMappingLoadDryRunResponse
object
3 properties 3 required
WorkspaceDetailResponse
object
13 properties 7 required
InputMappingLoadRequest
object
2 properties 1 required
BucketListingUpdateJobResponse
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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