Keboola schedules API
The schedules API from Keboola — 4 operation(s) for schedules.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/keboola-schedules-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: The API allows to manage schedules.
version: 1.0.0
title: Scheduler Schedules API
contact:
email: devel@keboola.com
license:
name: MIT
url: https://opensource.org/licenses/MIT
servers:
- description: SwaggerHub API Auto Mocking
url: https://virtserver.swaggerhub.com/odinuv/scheduler/1.0.0
- description: Azure Testing
url: https://scheduler.east-us-2.azure.keboola-testing.com
- description: US AWS Production
url: https://scheduler.keboola.com
- description: EU AWS Production
url: https://scheduler.eu-central-1.keboola.com
security:
- ApiKeyAuth: []
tags:
- name: schedules
paths:
/schedules:
get:
tags:
- schedules
summary: List schedules
description: 'Lists activated configurations of schedules
'
parameters:
- in: query
name: componentId
description: List schedules for a given *Component ID*. If used, must be combined with configurationId.
required: false
schema:
type: string
examples:
id:
summary: Example component
value: keboola.ex-db-snowflake
- in: query
name: configurationId
description: List schedules for a given *Configuration ID*. If used, must be combined with ComponentId.
required: false
schema:
type: string
examples:
id:
summary: Example configuration
value: '12345'
responses:
'200':
description: Success response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Schedule'
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
summary: Activate Schedule
operationId: activate
tags:
- schedules
description: 'Activates and existing configuration of `keboola.scheduler` so that it becomes an active schedule.
'
requestBody:
description: 'This will read the configuration (identified by the given `configurationId` and optionally `configurationVersionId`) of a `keboola.scheduler` component and read the scheduler configuration from there. The activated configuration data is returned in the response. The read configuration version is recorded in the schedule and will be used until another configuration version is activated using this API call.
'
content:
application/json:
schema:
type: object
required:
- configurationId
properties:
configurationId:
type: string
configurationVersionId:
type: string
examples:
Activate configuration:
value:
configurationId: 12333456
Activate a given version of the configuration:
value:
configurationId: 12333456
configurationVersionId: 12
responses:
'200':
description: Schedule Activated
content:
application/json:
schema:
$ref: '#/components/schemas/Schedule'
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/schedules/{scheduleId}:
get:
summary: Get schedule detail
operationId: getSchedule
tags:
- schedules
description: 'Get details of a specified schedule
'
parameters:
- in: path
name: scheduleId
description: Schedule ID
required: true
schema:
type: string
responses:
'200':
description: Success response
content:
application/json:
schema:
$ref: '#/components/schemas/Schedule'
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
summary: Delete schedule
operationId: deleteSchedule
tags:
- schedules
description: 'Permanently deactivate a specified schedule. The schedule configuration of the `keboola.scheduler` component will not be touched.
'
parameters:
- in: path
name: scheduleId
description: Schedule ID
required: true
schema:
type: string
responses:
'204':
description: Success response
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/schedules/{scheduleId}/refreshToken:
post:
summary: Refresh the schedule token
operationId: refreshToken
tags:
- schedules
description: 'Refresh the the token associated with the schedule, if the token is refreshed directly in Storage API, the schedule won''t work.
'
parameters:
- in: path
name: scheduleId
description: Schedule ID
required: true
schema:
type: string
responses:
'202':
description: Success response
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/configurations/{configurationId}:
delete:
summary: Delete schedules for configuration
operationId: deleteSchedulesForConfiguration
tags:
- schedules
description: 'Permanently deactivate schedules for given configuration. The schedule configurations of the `keboola.scheduler` component will not be touched.
'
parameters:
- in: path
name: configurationId
description: Configuration ID
required: true
schema:
type: string
responses:
'204':
description: Success response
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
required:
- error
- code
- status
- context
properties:
error:
type: string
example: The value foobar is invalid
code:
type: integer
example: 400
status:
type: string
enum:
- error
exceptionId:
type: string
example: scheduler-1234567890
context:
type: object
Schedule:
type: object
required:
- id
- tokenId
- configurationId
- configurationVersionId
- schedule
- target
- executions
properties:
id:
type: string
example: 123456789
tokenId:
type: string
example: 123456790
description: 'ID of Storage token used to execute the schedule.
'
configurationId:
type: string
example: 123456790
description: 'ID of the configuration of the schedule.
'
configurationVersionId:
type: string
example: 123456790
description: 'Version of the configuration of the schedule.
'
schedule:
type: object
required:
- cronTab
- timezone
- state
properties:
cronTab:
type: string
example: '*/2 * * * *'
description: 'Cron expression describing the schedule
'
timezone:
type: string
example: UTC
description: 'Timezone of the cron expression evaluation, either (UTC) a name of offset (+0100).
'
state:
type: string
enum:
- enabled
- disabled
target:
type: object
required:
- componentId
- configurationId
- mode
- tag
properties:
componentId:
type: string
example: keboola.ex-db-snowflake
configurationId:
type: string
example: 12345
mode:
type: string
example: run
tag:
type: string
example: 1.2.3
executions:
type: array
items:
type: object
required:
- jobId
- executionTime
properties:
jobId:
type: string
example: 12345
executionTime:
type: string
format: date-time
example: '2019-06-21T09:12:33.001Z'
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-StorageApi-Token