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

The Buckets API from Keboola — 28 operation(s) for buckets.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 36 operations across 28 paths, and defines 32 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.

36 operations 28 paths 32 schemas 6 DELETE14 GET2 PATCH12 POST2 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 Buckets API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-StorageApi-Token (ApiKeyAuth).

Paths & Operations 36

Across 28 paths, the API surfaces 36 operations — 6 DELETE, 14 GET, 2 PATCH, 12 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Buckets 36
GET
/v2/storage/branch/{branchId}/buckets/register-guide
Get bucket registration guide
get_/v2/storage/branch/{branchId}/buckets/register-guide::BucketRegisterGuideAction 4 params → 200400403501
GET
/v2/storage/buckets/register-guide
Get bucket registration guide
get_/v2/storage/buckets/register-guide::BucketRegisterGuideAction 3 params → 200400403501
GET
/v2/storage/branch/{branchId}/buckets
List buckets
get_/v2/storage/branch/{branchId}/buckets::BucketsListAction 2 params → 200
GET
/v2/storage/buckets
List buckets
get_/v2/storage/buckets::BucketsListAction 1 param → 200
POST
/v2/storage/branch/{branchId}/buckets/{bucketId}/metadata
Create or update bucket metadata
post_/v2/storage/branch/{branchId}/buckets/{bucketId}/metadata::BucketCreateOrUpdateMetadataAction 2 params body → 201404
POST
/v2/storage/buckets/{bucketId}/metadata
Create or update bucket metadata
post_/v2/storage/buckets/{bucketId}/metadata::BucketCreateOrUpdateMetadataAction 1 param body → 201404
DELETE
/v2/storage/branch/{branchId}/buckets/{bucketId}/metadata/{metadataId}
Delete bucket metadata
delete_/v2/storage/branch/{branchId}/buckets/{bucketId}/metadata/{metadataId}::BucketDeleteMetadataAction 3 params → 204404403
DELETE
/v2/storage/buckets/{bucketId}/metadata/{metadataId}
Delete bucket metadata
delete_/v2/storage/buckets/{bucketId}/metadata/{metadataId}::BucketDeleteMetadataAction 2 params → 204404403
GET
/v2/storage/branch/{branchId}/buckets/{bucketId}
Get bucket detail
get_/v2/storage/branch/{branchId}/buckets/{bucketId}::BucketDetailAction 3 params → 200404403
GET
/v2/storage/buckets/{bucketId}
Get bucket detail
get_/v2/storage/buckets/{bucketId}::BucketDetailAction 2 params → 200404403
GET
/v2/storage/branch/{branchId}/buckets/{bucketId}/tables
List tables in a bucket
get_/v2/storage/branch/{branchId}/buckets/{bucketId}/tables::BucketGetTablesAction 3 params → 200404400403503
GET
/v2/storage/buckets/{bucketId}/tables
List tables in a bucket
get_/v2/storage/buckets/{bucketId}/tables::BucketGetTablesAction 2 params → 200404400403503
GET
/v2/storage/branch/{branchId}/buckets/{bucketId}/owner
Get bucket owner information
get_/v2/storage/branch/{branchId}/buckets/{bucketId}/owner::BucketOwnerDetailAction 2 params → 200404
POST
/v2/storage/branch/{branchId}/buckets/{bucketId}/owner
Update bucket owner
post_/v2/storage/branch/{branchId}/buckets/{bucketId}/owner::BucketOwnerUpdateAction 2 params → 204404
GET
/v2/storage/buckets/{bucketId}/owner
Get bucket owner information
get_/v2/storage/buckets/{bucketId}/owner::BucketOwnerDetailAction 1 param → 200404
POST
/v2/storage/buckets/{bucketId}/owner
Update bucket owner
post_/v2/storage/buckets/{bucketId}/owner::BucketOwnerUpdateAction 1 param → 204404
POST
/v2/storage/branch/{branchId}/buckets/{id}/tables-async
Create a table asynchronously in a bucket
post_/v2/storage/branch/{branchId}/buckets/{id}/tables-async::CreateTableAsyncAction 3 params body → 200404400403
POST
/v2/storage/buckets/{id}/tables-async
Create a table asynchronously in a bucket
post_/v2/storage/buckets/{id}/tables-async::CreateTableAsyncAction 2 params body → 200404400403
GET
/v2/storage/branch/{branchId}/buckets/{bucketId}/listing
Get bucket listing detail
get_/v2/storage/branch/{branchId}/buckets/{bucketId}/listing::BucketListingDetailAction 2 params → 200404403
POST
/v2/storage/branch/{branchId}/buckets/{bucketId}/listing
Create bucket listing
post_/v2/storage/branch/{branchId}/buckets/{bucketId}/listing::BucketListingCreateAction 2 params → 400404403501202
DELETE
/v2/storage/branch/{branchId}/buckets/{bucketId}/listing
Delete bucket listing
delete_/v2/storage/branch/{branchId}/buckets/{bucketId}/listing::BucketListingDeleteAction 2 params → 403404202
PATCH
/v2/storage/branch/{branchId}/buckets/{bucketId}/listing
Update bucket listing
patch_/v2/storage/branch/{branchId}/buckets/{bucketId}/listing::BucketListingUpdateAction 2 params → 400403404501202
GET
/v2/storage/buckets/{bucketId}/listing
Get bucket listing detail
get_/v2/storage/buckets/{bucketId}/listing::BucketListingDetailAction 1 param → 200404403
POST
/v2/storage/buckets/{bucketId}/listing
Create bucket listing
post_/v2/storage/buckets/{bucketId}/listing::BucketListingCreateAction 1 param → 400404403501202
DELETE
/v2/storage/buckets/{bucketId}/listing
Delete bucket listing
delete_/v2/storage/buckets/{bucketId}/listing::BucketListingDeleteAction 1 param → 403404202
PATCH
/v2/storage/buckets/{bucketId}/listing
Update bucket listing
patch_/v2/storage/buckets/{bucketId}/listing::BucketListingUpdateAction 1 param → 400403404501202
GET
/v2/storage/branch/{branchId}/listings
List bucket listings
get_/v2/storage/branch/{branchId}/listings::BucketListingsListAction 1 param → 200501
GET
/v2/storage/listings
List bucket listings
get_/v2/storage/listings::BucketListingsListAction → 200501
PUT
/v2/storage/branch/{branchId}/buckets/{bucketId}/refresh
Refresh a bucket
put_/v2/storage/branch/{branchId}/buckets/{bucketId}/refresh::RefreshAction 2 params → 404400403202
PUT
/v2/storage/buckets/{bucketId}/refresh
Refresh a bucket
put_/v2/storage/buckets/{bucketId}/refresh::RefreshAction 1 param → 404400403202
DELETE
/v2/storage/branch/{branchId}/buckets/{bucketId}/share
Delete bucket share
delete_/v2/storage/branch/{branchId}/buckets/{bucketId}/share::BucketShareDeleteAction 2 params → 202403404
DELETE
/v2/storage/buckets/{bucketId}/share
Delete bucket share
delete_/v2/storage/buckets/{bucketId}/share::BucketShareDeleteAction 1 param → 202403404
POST
/v2/storage/branch/{branchId}/buckets/{bucketId}/share-organization
Share bucket with organization
post_/v2/storage/branch/{branchId}/buckets/{bucketId}/share-organization::BucketShareOrganizationAction 2 params → 202400403501
POST
/v2/storage/buckets/{bucketId}/share-organization
Share bucket with organization
post_/v2/storage/buckets/{bucketId}/share-organization::BucketShareOrganizationAction 1 param → 202400403501
POST
/v2/storage/branch/{branchId}/buckets/{bucketId}/share-organization-project
Share bucket with organization project
post_/v2/storage/branch/{branchId}/buckets/{bucketId}/share-organization-project::BucketShareOrganizationProjectAction 2 params → 202400403404501
POST
/v2/storage/buckets/{bucketId}/share-organization-project
Share bucket with organization project
post_/v2/storage/buckets/{bucketId}/share-organization-project::BucketShareOrganizationProjectAction 1 param → 202400403404501

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are BucketDetailResponse (29 properties), RefreshJobResponse (27 properties), TableCreateResponse (26 properties), BucketCreateResponse (25 properties). Each schema is shown below with its type and property counts.

BucketListingCreateJobResult
object
4 properties 4 required
RefreshJobParams
object
3 properties 3 required
CreateTableAsyncFromTimeTravelRequest
object
Request body for creating a table from a time travel source. Some parameters are optional or only used for specific backends.
10 properties 5 required
BucketOwnerDetailResponse
object
3 properties 3 required
BucketListingDeleteResponse
object
14 properties 8 required
TableSnapshotCreateJobResult
object
7 properties 6 required
SourceTableResponse
object
4 properties 4 required
ProjectBucketListingResponse
object
7 properties 5 required
BucketRegisterGuideResponse
object
1 property 1 required
BucketListingUpdateJobParams
object
7 properties 4 required
BucketListingDeleteJobParams
object
3 properties 3 required
TableCreateResponse
object
26 properties 22 required
RefreshJobResponse
object
27 properties 18 required
FileDeleteResponse
object
14 properties 8 required
BucketDetailResponse
object
29 properties 19 required
BucketShareOrganizationProjectResponse
object
14 properties 8 required
JobResponse
object
Response object for an asynchronous storage job.
14 properties 10 required
BucketListingDetailResponse
object
5 properties 3 required
BucketShareOrganizationResponse
object
14 properties 8 required
BigQueryBucketListingDetailResponse
object
3 properties 2 required
TableSwapResult
object
2 properties 2 required
CreateMetadataWithProviderRequest
object
2 properties 2 required
BucketListingCreateJobParams
object
7 properties 6 required
CreateTableAsyncFromFileRequest
object
Request body for creating a table from a file. Some parameters are optional or only used for specific backends.
9 properties 4 required
MetadataItemResponse
object
Single metadata record.
5 properties 5 required
BucketShareDeleteResponse
object
14 properties 8 required
BigQueryListingSection
object
2 properties 2 required
CreateTableAsyncFromWorkspaceRequest
object
Request body for creating a table from a workspace. Some parameters are optional or only used for specific backends.
11 properties 4 required
BucketCreateResponse
object
25 properties 19 required
TableExportJobResponse
object
1 property
BucketListingUpdateJobResponse
object
4 properties 3 required
CreateTableAsyncFromSnapshotRequest
object
Request body for creating a table from a snapshot. Some parameters are optional or only used for specific backends.
9 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keboola-buckets-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 Columns API
AE Profile APIs.io
Keboola Component Configuration Metadata API
AE Profile APIs.io
Keboola Component Configuration Row Versions API
AE Profile APIs.io
#Buckets
← Back to K APIs
API Details
ID
keboola:keboola-buckets-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