Windmill

Windmill Config API

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

GitHub OpenAPI

Operations 10

GET /configs/list_worker_groups List Worker Groups #
GET /configs/get/{name} Get Config #
POST /configs/update/{name} Update Config #
DELETE /configs/update/{name} Delete Config #
GET /configs/list List Configs #
GET /configs/list_autoscaling_events/{worker_group} List Autoscaling Events #
GET /configs/native_kubernetes_autoscaling_healthcheck Check Kubernetes Autoscaling Health for a Worker Group #
GET /configs/list_available_python_versions Get Currently Available Python Versions Provided by UV #
GET /configs/list_all_workspace_dependencies List All Workspace Dependencies #
GET /configs/list_all_dedicated_with_deps List All Dedicated Scripts with Their Dependencies #

Documentation

📖
Documentation
https://www.windmill.dev/docs/intro
📖
GettingStarted
https://www.windmill.dev/docs/getting_started/how_to_use_windmill
📖
Authentication
https://www.windmill.dev/docs/core_concepts/authentification

Specifications

⚙
OpenAPI
https://artifacts.apis.io/windmill/openapi/windmill-config-api-openapi.yml

Other Resources

🔗
APIReferenceDocumentation
https://app.windmill.dev/openapi.html
🔗
HTTPRoutes
https://www.windmill.dev/docs/core_concepts/http_routing
🔗
CLI
https://www.windmill.dev/docs/advanced/cli
🔗
SelfHosting
https://www.windmill.dev/docs/advanced/self_host
🔗
TypeScriptSDK
https://www.windmill.dev/docs/advanced/clients/ts_client
🔗
PythonSDK
https://www.windmill.dev/docs/advanced/clients/python_client
🔗
SpectralRules
https://artifacts.apis.io/windmill/rules/windmill-api-rules.yml

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/windmill:windmill-config-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

windmill-config-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.694.0
  title: Windmill Config API
  contact:
    name: Windmill Team
    email: contact@windmill.dev
    url: https://windmill.dev
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://windmill.dev/img/windmill.svg
servers:
- url: /api
security:
- bearerAuth: []
- cookieAuth: []
tags:
- name: Config
paths:
  /configs/list_worker_groups:
    get:
      summary: List Worker Groups
      operationId: listWorkerGroups
      tags:
      - Config
      responses:
        '200':
          description: a list of worker group configs
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    config: {}
                  required:
                  - name
                  - config
  /configs/get/{name}:
    get:
      summary: Get Config
      operationId: getConfig
      tags:
      - Config
      parameters:
      - $ref: '#/components/parameters/Name'
      responses:
        '200':
          description: a config
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Configs'
      x-operation-id-source: normalized
      x-operation-id-original: get config
  /configs/update/{name}:
    post:
      summary: Update Config
      operationId: updateConfig
      tags:
      - Config
      parameters:
      - $ref: '#/components/parameters/Name'
      requestBody:
        description: worker group
        required: true
        content:
          application/json:
            schema: {}
      responses:
        '200':
          description: Update a worker group
          content:
            text/plain:
              schema:
                type: string
    delete:
      summary: Delete Config
      operationId: deleteConfig
      tags:
      - Config
      parameters:
      - $ref: '#/components/parameters/Name'
      responses:
        '200':
          description: Delete config
          content:
            text/plain:
              schema:
                type: string
  /configs/list:
    get:
      summary: List Configs
      operationId: listConfigs
      tags:
      - Config
      responses:
        '200':
          description: list of configs
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Config'
  /configs/list_autoscaling_events/{worker_group}:
    get:
      summary: List Autoscaling Events
      operationId: listAutoscalingEvents
      tags:
      - Config
      parameters:
      - name: worker_group
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PerPage'
      responses:
        '200':
          description: List of autoscaling events
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AutoscalingEvent'
  /configs/native_kubernetes_autoscaling_healthcheck:
    get:
      summary: Check Kubernetes Autoscaling Health for a Worker Group
      operationId: nativeKubernetesAutoscalingHealthcheck
      tags:
      - Config
      responses:
        '200':
          description: Kubernetes autoscaling is healthy
        '400':
          description: Error
          content:
            text/plain:
              schema:
                type: string
  /configs/list_available_python_versions:
    get:
      summary: Get Currently Available Python Versions Provided by UV
      operationId: listAvailablePythonVersions
      tags:
      - Config
      responses:
        '200':
          description: List of python versions
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
  /configs/list_all_workspace_dependencies:
    get:
      summary: List All Workspace Dependencies
      operationId: listAllWorkspaceDependencies
      tags:
      - Config
      responses:
        '200':
          description: a list of workspace dependency summaries
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    workspace_id:
                      type: string
                    name:
                      type: string
                    language:
                      $ref: '#/components/schemas/ScriptLang'
                  required:
                  - workspace_id
                  - language
  /configs/list_all_dedicated_with_deps:
    get:
      summary: List All Dedicated Scripts with Their Dependencies
      operationId: listAllDedicatedWithDeps
      tags:
      - Config
      responses:
        '200':
          description: a list of dedicated scripts with workspace dependencies
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    workspace_id:
                      type: string
                    path:
                      type: string
                    language:
                      $ref: '#/components/schemas/ScriptLang'
                    workspace_dep_names:
                      type: array
                      items:
                        type: string
                  required:
                  - workspace_id
                  - path
                  - language
                  - workspace_dep_names
components:
  parameters:
    PerPage:
      name: per_page
      description: number of items to return for a given page (default 30, max 100)
      in: query
      schema:
        type: integer
    Page:
      name: page
      description: which page to return (start at 1, default 1)
      in: query
      schema:
        type: integer
    Name:
      name: name
      in: path
      required: true
      schema:
        type: string
  schemas:
    Configs:
      type:
      - object
      - 'null'
      properties:
        alerts:
          type: array
          items:
            $ref: '#/components/schemas/Alert'
    Alert:
      type: object
      properties:
        name:
          type: string
        tags_to_monitor:
          type: array
          items:
            type: string
        jobs_num_threshold:
          type: integer
        alert_cooldown_seconds:
          type: integer
        alert_time_threshold_seconds:
          type: integer
      required:
      - name
      - tags_to_monitor
      - jobs_num_threshold
      - alert_cooldown_seconds
      - alert_time_threshold_seconds
    AutoscalingEvent:
      type: object
      properties:
        id:
          type: integer
          format: int64
        worker_group:
          type: string
        event_type:
          type: string
        desired_workers:
          type: integer
        reason:
          type: string
        applied_at:
          type: string
          format: date-time
    ScriptLang:
      type: string
      enum:
      - python3
      - deno
      - go
      - bash
      - powershell
      - postgresql
      - mysql
      - bigquery
      - snowflake
      - mssql
      - oracledb
      - graphql
      - nativets
      - bun
      - php
      - rust
      - ansible
      - csharp
      - nu
      - java
      - ruby
      - rlang
      - duckdb
      - bunnative
    Config:
      type: object
      properties:
        name:
          type: string
        config:
          type: object
      required:
      - name
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    cookieAuth:
      type: apiKey
      in: cookie
      name: token
externalDocs:
  description: documentation portal
  url: https://windmill.dev
x-provenance:
  method: harvested
  publisher: Windmill
  source: https://app.windmill.dev/api/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)