/
WI
windmill
/
Windmill API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 45m ago · Updated 6h ago
View markdown
windmill
Windmill API
post
create customer portal session
OpenAPI 3.0.3
Apache 2.0
raw.githubusercontent.com
2026-08-10
822
352
994.2 KB
964225251155
agent_workers
5
amqp_trigger
8
app
41
asset
9
audit
2
azure_trigger
13
capture
7
concurrencyGroups
4
config
10
data_metric
1
dbt
3
documentation
2
draft
5
email_trigger
8
favorite
2
flow
20
flow_conversations
3
folder
11
gcp_trigger
11
Git Sync
10
granular_acl
3
group
19
health
2
helpers
24
http_trigger
9
hubPublish
17
indexSearch
7
input
6
integration
1
job
98
kafka_trigger
10
mcp
1
mcp_oauth
3
metrics
3
mqtt_trigger
8
native_trigger
13
nats_trigger
8
npm_proxy
4
oauth
13
oidc
1
openapi
2
path_autocomplete
1
postgres_trigger
20
raw_app
1
resource
27
schedule
10
script
36
service_logs
2
setting
52
post
Refreshes the passwords for the custom_instance_user and the custom_instance_replication_user (used by postgres triggers)
post
Returns the set-up statuses of custom instance pg databases
post
Runs CREATE DATABASE on the Windmill Postgres and grants access to the custom_instance_user
post
Drops a custom instance database (superadmin only, irreversible)
get
get global settings
post
post global settings
get
get instance ruff config (unauthenticated)
get
get local settings
post
test smtp
post
test critical channels
get
Get all critical alerts
post
Acknowledge a critical alert
post
Acknowledge all unacknowledged critical alerts
post
test license key
post
test object storage config
get
get current or last object storage usage computation (null if never run)
post
start a background computation of object storage usage by top-level folder
post
start a manual cleanup of expired logs from object storage
get
get status of the manual log cleanup task
get
get status of the audit-log object-store export cursor
post
start an opt-in historical backfill of audit logs to object storage
get
get status of the audit-log object-store historical backfill
post
send stats
post
restart worker group
get
get telemetry stats with HMAC signature (EE only)
get
get latest key renewal attempt
post
renew license key
get
get cap-usage status for the currently-loaded offline license
get
per-instance binding hash for offline license issuance
post
create customer portal session
post
test metadata
get
list global settings
get
list git-sync repositories whose webhook still points at a previous receiver
get
get full instance config (global settings + worker configs)
put
update instance config (bulk upsert, no deletes). Empty or missing global_settings/worker_configs are skipped.
get
get minimum worker versions required to stay alive
get
get JWKS for Vault JWT authentication
post
test secret backend connection (HashiCorp Vault)
post
migrate secrets from database to HashiCorp Vault
post
migrate secrets from HashiCorp Vault to database
post
test Azure Key Vault connection
post
migrate secrets from database to Azure Key Vault
post
migrate secrets from Azure Key Vault to database
post
test connection to AWS Secrets Manager
post
migrate secrets from database to AWS Secrets Manager
post
migrate secrets from AWS Secrets Manager to database
get
get secondary storage names
get
Get all critical alerts for this workspace
post
Acknowledge a critical alert for this workspace
post
Acknowledge all unacknowledged critical alerts for this workspace
post
Mute critical alert UI for this workspace
post
Set public app rate limit for this workspace
settings
4
sqs_trigger
8
teams
1
token
1
trigger
2
user
57
variable
10
volume
4
websocket_trigger
8
worker
10
workspace
128
workspace_dependencies
5
workspace_integration
8
setting
create customer portal session
post
/settings/customer_portal
Query parameters
license_key
string
Response
url to portal