Skip to main content

​
List Schedules

Returns all schedules. 
curl -X GET http://localhost:8080/api/schedules

​
Response

​
schedules
array
Array of schedule objects

​
Create Schedule

Creates a new schedule. 
curl -X POST http://localhost:8080/api/schedules \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "proj-123",
    "name": "Daily Sensor Data Processing",
    "pipelines": ["pipe-456", "pipe-789"],
    "cron_schedule": "0 2 * * *",
    "enabled": true
  }'

​
Request Body

​
project_id
string
required
Project ID to associate with
​
name
string
required
Schedule name
​
pipelines
array
required
Array of pipeline IDs to execute
​
cron_schedule
string
required
Cron expression defining the scheduleExamples:
  • "0 * * * *" - Every hour
  • "0 0 * * *" - Daily at midnight
  • "0 2 * * MON" - Every Monday at 2 AM
  • "*/15 * * * *" - Every 15 minutes
​
enabled
boolean
Whether schedule is enabled (defaults to true)

​
Response

Returns the created schedule object.

​
Get Schedule

Returns a single schedule by ID. 
curl -X GET http://localhost:8080/api/schedules/sched-123

​
Path Parameters

​
id
string
required
Schedule ID

​
Response

Returns the schedule object (see List Schedules for schema).

​
Update Schedule

Updates a schedule’s configuration. 
curl -X PUT http://localhost:8080/api/schedules/sched-123 \
  -H "Content-Type: application/json" \
  -d '{
    "cron_schedule": "0 3 * * *",
    "enabled": false
  }'

​
Path Parameters

​
id
string
required
Schedule ID

​
Request Body

All fields are optional. Only provided fields will be updated.
​
name
string
New name
​
pipelines
array
New pipelines array (replaces existing)
​
cron_schedule
string
New cron expression
​
enabled
boolean
New enabled status

​
Response

Returns the updated schedule object.

​
Delete Schedule

Deletes a schedule. 
curl -X DELETE http://localhost:8080/api/schedules/sched-123

​
Path Parameters

​
id
string
required
Schedule ID

​
Response

Returns 204 No Content on success.

Build docs developers (and LLMs) love

Get started for freeTalk to us