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

Windmill schedule API

The schedule API from Windmill — 10 operation(s) for schedule.

Windmill schedule API is one of 59 APIs that Windmill 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, API documentation, a getting-started guide, and authentication docs.

This API exposes 10 operations across 10 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.694.0.

Requests are made against a single base URL, /api.

10 operations 10 paths 5 schemas 1 DELETE4 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.694.0
Base URL
https://app.windmill.dev/api
Authentication
HTTP Bearer, API Key
License
Resource Areas
1

Authentication & Security 2

Windmill schedule API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the cookie as token (cookieAuth). By default, every request must be authenticated.

Paths & Operations 10

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

schedule 10
POST
/schedules/preview
Preview Schedule
previewSchedule body → 200
POST
/w/{workspace}/schedules/create
Create Schedule
createSchedule 1 param body → 201
POST
/w/{workspace}/schedules/update/{path}
Update Schedule
updateSchedule 2 params body → 200
POST
/w/{workspace}/schedules/setenabled/{path}
Set Enabled Schedule
setScheduleEnabled 2 params body → 200
DELETE
/w/{workspace}/schedules/delete/{path}
Delete Schedule
deleteSchedule 2 params → 200
GET
/w/{workspace}/schedules/get/{path}
Get Schedule
getSchedule 2 params → 200
GET
/w/{workspace}/schedules/exists/{path}
Does Schedule Exists
existsSchedule 2 params → 200
GET
/w/{workspace}/schedules/list
List Schedules
listSchedules 12 params → 200
GET
/w/{workspace}/schedules/list_with_jobs
List Schedules with Last 20 Jobs
listSchedulesWithJobs 3 params → 200
POST
/w/{workspace}/schedules/setdefaulthandler
Set Default Error or Recoevery Handler
setDefaultErrorOrRecoveryHandler 1 param body → 201

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Schedule (32 properties), NewSchedule (28 properties), EditSchedule (24 properties). Each schema is shown below with its type and property counts.

ScheduleWJobs
ScriptArgs
object
The arguments to pass to the script or flow
Schedule
object
32 properties 11 required
NewSchedule
object
28 properties 6 required
EditSchedule
object
24 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

windmill-schedule-api-openapi.yml Raw ↑

Other APIs Windmill publishes across the network.

Windmill admin API
Windmill agent_workers API
Windmill app API
Windmill asset API
Windmill audit API
Windmill azure_trigger API
Windmill capture API
Windmill concurrencyGroups API
Windmill config API
Windmill documentation API
Windmill draft API
Windmill email_trigger API