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

Keboola Files API

The Files API from Keboola — 4 operation(s) for files.

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

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

This API exposes 4 operations across 4 paths, and defines 12 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.

4 operations 4 paths 12 schemas 2 DELETE2 GET

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
License
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 4

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

Files 4
GET
/v2/storage/branch/{branchId}/files/{fileId}/content
Get file content
get_/v2/storage/branch/{branchId}/files/{fileId}/content::FileContentAction 2 params → 200400404502
GET
/v2/storage/files/{fileId}/content
Get file content
get_/v2/storage/files/{fileId}/content::FileContentAction 1 param → 200400404502
DELETE
/v2/storage/branch/{branchId}/files/{fileId}
Delete a file
delete_/v2/storage/branch/{branchId}/files/{fileId}::FileDeleteAction 3 params → 204404202
DELETE
/v2/storage/files/{fileId}
Delete a file
delete_/v2/storage/files/{fileId}::FileDeleteAction 2 params → 204404202

Schemas 12

The contract defines 12 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
FileDeleteJobParams
object
4 properties 4 required
TableCreateResponse
object
26 properties 22 required
RefreshJobResponse
object
27 properties 18 required
TableSwapResult
object
2 properties 2 required
FileDeleteResponse
object
14 properties 8 required
BucketListingDeleteResponse
object
14 properties 8 required
TableSnapshotCreateJobResult
object
7 properties 6 required
SourceTableResponse
object
4 properties 4 required
JobResponse
object
Response object for an asynchronous storage job.
14 properties 10 required
TableExportJobResponse
object
1 property
BucketListingUpdateJobResponse
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keboola-files-api-openapi.yml Raw ↑

Other APIs Keboola publishes across the network.

Keboola Actions API
Keboola Admin Apps API
Keboola Admin Stacks API
Keboola Admin Users API
Keboola Admin Vendors API
Keboola App API
Keboola Auth API
Keboola Authorize API
Keboola Branch metadata API
Keboola Buckets API
Keboola Columns API
Keboola Component Configuration Metadata API