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

The jobs API from Keboola — 13 operation(s) for jobs.

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

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

This API exposes 14 operations across 13 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.

14 operations 13 paths 8 schemas 10 GET4 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
License
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 14

Across 13 paths, the API surfaces 14 operations — 10 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

jobs 14
POST
/api/v1/branches/{branchId}/workspaces/{workspaceId}/queries
Submit query job
2 params body → 201400401500
GET
/api/v1/queries/{queryJobId}
Get job status
1 param → 200400500
POST
/api/v1/queries/{queryJobId}/cancel
Cancel job
1 param body → 200400401404500
GET
/api/v1/queries/{queryJobId}/{statementId}/export
Export job results as CSV or Parquet
4 params → 200400404413500
GET
/api/v1/queries/{queryJobId}/{statementId}/profile
Get statement profile
2 params → 200500
GET
/api/v1/queries/{queryJobId}/{statementId}/results
Get job results
4 params → 200400404500
GET
/api/v1/queries/{queryJobId}/{statementId}/results/stream
Stream job results
2 params → 200400404426500
GET
/jobsdeprecated
List jobs
24 params → 200default
POST
/jobs
Create a job
createJob 1 param body → 201default
GET
/jobs/{jobId}
Get job detail
getJob 1 param → 200default
POST
/jobs/{jobId}/kill
Set job for termination
killJob 1 param → 202default
GET
/jobs/{jobId}/open-api-lineage
Get job OpenLineage data
getJobOpenApiLineage 1 param → 200default
GET
/search/jobs
Search jobs
26 params → 200default
GET
/search/grouped-jobs
Search grouped jobs
32 params → 200default

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Job (29 properties), OpenLineageCompleteEvent (6 properties), OpenLineageStartEvent (6 properties), Error (4 properties). Each schema is shown below with its type and property counts.

OpenLineageEvent
object
OpenLineageEventList
array
OpenLineage event list
Error
object
4 properties 3 required
Job
object
29 properties 10 required
JobStatus
string
OpenLineageCompleteEvent
object
Job execution end event, including information about output mapping tables.
6 properties 6 required
OpenLineageStartEvent
object
Job execution start event, including information about input mapping tables.
6 properties 6 required
JobType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keboola-jobs-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