Windmill

Windmill Setting API

The setting API from Windmill — 43 operation(s) for setting.

GitHub OpenAPI

Operations 46

POST /settings/refresh_custom_instance_user_pwd Refreshes the Password for the Custom_instance_user #
POST /settings/list_custom_instance_pg_databases Returns the Set-up Statuses of Custom Instance Pg Databases #
POST /settings/setup_custom_instance_pg_database/{name} Runs CREATE DATABASE on the Windmill Postgres and Grants Access to the… #
POST /settings/drop_custom_instance_pg_database/{name} Drops a Custom Instance Database (superadmin Only, Irreversible) #
GET /settings/global/{key} Get Global Settings #
POST /settings/global/{key} Post Global Settings #
GET /settings_u/ruff_config Get Instance Ruff Config (unauthenticated) #
GET /settings/local Get Local Settings #
POST /settings/test_smtp Test Smtp #
POST /settings/test_critical_channels Test Critical Channels #
GET /settings/critical_alerts Get All Critical Alerts #
POST /settings/critical_alerts/{id}/acknowledge Acknowledge a Critical Alert #
POST /settings/critical_alerts/acknowledge_all Acknowledge All Unacknowledged Critical Alerts #
POST /settings/test_license_key Test License Key #
POST /settings/test_object_storage_config Test Object Storage Config #
GET /settings/object_storage_usage Get Current or Last Object Storage Usage Computation (null if Never Run) #
POST /settings/object_storage_usage Start a Background Computation of Object Storage Usage by Top-level Folder #
POST /settings/run_log_cleanup Start a Manual Cleanup of Expired Logs from Object Storage #
GET /settings/log_cleanup_status Get Status of the Manual Log Cleanup Task #
POST /settings/send_stats Send Stats #
POST /settings/restart_worker_group/{worker_group} Restart Worker Group #
GET /settings/get_stats Get Telemetry Stats with HMAC Signature (EE Only) #
GET /settings/latest_key_renewal_attempt Get Latest Key Renewal Attempt #
POST /settings/renew_license_key Renew License Key #
POST /settings/customer_portal Create Customer Portal Session #
POST /saml/test_metadata Test Metadata #
GET /settings/list_global List Global Settings #
GET /settings/instance_config Get Full Instance Config (global Settings + Worker Configs) #
PUT /settings/instance_config Update Instance Config (bulk Upsert, No Deletes). #
GET /min_keep_alive_version Get Minimum Worker Versions Required to Stay Alive #
GET /.well-known/jwks.json Get JWKS for Vault JWT Authentication #
POST /settings/test_secret_backend Test Secret Backend Connection (HashiCorp Vault) #
POST /settings/migrate_secrets_to_vault Migrate Secrets from Database to HashiCorp Vault #
POST /settings/migrate_secrets_to_database Migrate Secrets from HashiCorp Vault to Database #
POST /settings/test_azure_kv_backend Test Azure Key Vault Connection #
POST /settings/migrate_secrets_to_azure_kv Migrate Secrets from Database to Azure Key Vault #
POST /settings/migrate_secrets_from_azure_kv Migrate Secrets from Azure Key Vault to Database #
POST /settings/test_aws_sm_backend Test Connection to AWS Secrets Manager #
POST /settings/migrate_secrets_to_aws_sm Migrate Secrets from Database to AWS Secrets Manager #
POST /settings/migrate_secrets_from_aws_sm Migrate Secrets from AWS Secrets Manager to Database #
GET /w/{workspace}/workspaces/get_secondary_storage_names Get Secondary Storage Names #
GET /w/{workspace}/workspaces/critical_alerts Get All Critical Alerts for this Workspace #
POST /w/{workspace}/workspaces/critical_alerts/{id}/acknowledge Acknowledge a Critical Alert for this Workspace #
POST /w/{workspace}/workspaces/critical_alerts/acknowledge_all Acknowledge All Unacknowledged Critical Alerts for this Workspace #
POST /w/{workspace}/workspaces/critical_alerts/mute Mute Critical Alert UI for this Workspace #
POST /w/{workspace}/workspaces/public_app_rate_limit Set Public App Rate Limit for this Workspace #

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-setting-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-setting-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-setting-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.694.0
  title: Windmill Setting 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:


# --- truncated at 32 KB (38 KB total) ---
# Full source: https://artifacts.apis.io/windmill/openapi/windmill-setting-api-openapi.yml