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

Celonis Schedule API

The Schedule API is used to create, read, update, and delete schedules.

Celonis Schedule API is one of 17 APIs that Celonis publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Schedule. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 5 paths, and defines 7 schemas. It is described by OpenAPI 3.0.0, at version v1.2.0.

Requests are made against a single base URL, https://30f873b4-88d4-49ba-b327-6f651d7b99e6.remockly.com.

8 operations 5 paths 7 schemas 1 DELETE3 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.2.0
Base URL
https://{team_domain}.{realm}.celonis.cloud
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Celonis Schedule API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). An API key is passed in the header as AppKey (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Schedule 8

The Schedule API is used to create, read, update, and delete schedules.

GET
/api/scheduling/{id}
Get a schedule
findOne 1 param → 200204400403500
PUT
/api/scheduling/{id}
Update a schedule
update 1 param body → 200204400403500
DELETE
/api/scheduling/{id}
Delete a schedule
delete 1 param → 204400403500
PUT
/api/scheduling/{id}/change-status
Enable or Disable a schedule
changeStatus 2 params → 200204400403500
GET
/api/scheduling
List all schedules
findAll 1 param → 200204400403500
POST
/api/scheduling
Create a schedule
create body → 201204400403500
POST
/api/scheduling/{id}/run
Run a schedule
runSchedule 1 param → 200204400403500
GET
/api/scheduling/{id}/executions
List all executions of a schedule
findAllExecutions 4 params → 200204400403500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are SchedulingTransport (17 properties), NotebookExecutionTransport (14 properties), SchedulingConfig (12 properties), PageNotebookExecutionTransport (8 properties). Each schema is shown below with its type and property counts.

FrontendHandledBackendError
object
2 properties
ExceptionReference
object
3 properties
PageNotebookExecutionTransport
object
8 properties
JsonNode
NotebookExecutionTransport
object
14 properties 2 required
SchedulingConfig
object
12 properties
SchedulingTransport
object
17 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

celonis-schedule-api-openapi.yml Raw ↑

Other APIs Celonis publishes across the network.

Celonis Agents - Conversation API
Celonis Beta: OData Protocol API
Celonis Beta: Semantics for 3P AI Agents API
Celonis Data API
Celonis Job Execution API
Celonis Job Execution Group API
Celonis Login History API API
Celonis Members API API
Celonis Notebook API
Celonis Notebook Execution API
Celonis Notebook Resources API
Celonis OpenAPI Tool Calling API