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

The config API from Windmill — 9 operation(s) for config.

Windmill config API is one of 59 APIs that Windmill publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include config. 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 9 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 9 paths 5 schemas 1 DELETE8 GET1 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 config 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 9 paths, the API surfaces 10 operations — 1 DELETE, 8 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

config 10
GET
/configs/list_worker_groups
List Worker Groups
listWorkerGroups → 200
GET
/configs/get/{name}
Get Config
get config 1 param → 200
POST
/configs/update/{name}
Update Config
updateConfig 1 param body → 200
DELETE
/configs/update/{name}
Delete Config
deleteConfig 1 param → 200
GET
/configs/list
List Configs
listConfigs → 200
GET
/configs/list_autoscaling_events/{worker_group}
List Autoscaling Events
listAutoscalingEvents 3 params → 200
GET
/configs/native_kubernetes_autoscaling_healthcheck
Check Kubernetes Autoscaling Health for a Worker Group
nativeKubernetesAutoscalingHealthcheck → 200400
GET
/configs/list_available_python_versions
Get Currently Available Python Versions Provided by UV.
listAvailablePythonVersions → 200
GET
/configs/list_all_workspace_dependencies
List All Workspace Dependencies
listAllWorkspaceDependencies → 200
GET
/configs/list_all_dedicated_with_deps
List All Dedicated Scripts with Their Dependencies
listAllDedicatedWithDeps → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are AutoscalingEvent (6 properties), Alert (5 properties), Config (2 properties), Configs (1 property). Each schema is shown below with its type and property counts.

Config
object
2 properties 1 required
Configs
object
1 property
Alert
object
5 properties 5 required
AutoscalingEvent
object
6 properties
ScriptLang
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

windmill-config-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 documentation API
Windmill draft API
Windmill email_trigger API
Windmill favorite API