/
WI
windmill
/
Windmill API
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
1
Docs
History
Schema
Filter operations
agent_workers
5
ai
9
ai_evals
14
amqp_trigger
8
app
43
asset
10
audit
2
azure_trigger
13
capture
7
concurrencyGroups
4
config
10
data_metric
1
dbt
3
documentation
2
draft
7
email_trigger
8
favorite
2
flow
21
flow_conversations
4
folder
11
gcp_trigger
14
Git Sync
13
granular_acl
3
group
19
health
2
helpers
24
http_trigger
9
hubPublish
20
indexSearch
7
input
6
integration
2
job
104
kafka_trigger
10
mcp
1
mcp_oauth
3
metrics
3
mqtt_trigger
8
native_trigger
14
nats_trigger
8
npm_proxy
6
oauth
13
oidc
1
openapi
2
path_autocomplete
1
postgres_trigger
20
raw_app
1
resource
31
schedule
10
script
37
service_logs
2
setting
62
post
/settings/refresh_custom_instance_user_pwd
Refreshes the passwords for the custom_instance_user and the custom_instance_replication_user (used by postgres triggers)
get
/settings/external_instance_pg/status
Returns whether the external instance cluster is configured and how its last setup went
post
/settings/external_instance_pg/setup
Sets up the external instance cluster with its saved admin login, optionally rotating the passwords Windmill manages on it (enterprise edition only)
get
/settings/external_instance_pg/databases
Lists the databases Windmill created on the external instance cluster, with the workspaces whose data tables, Ducklake catalogs or pending fork cleanups use each
post
/settings/external_instance_pg/databases/{name}
Creates a database on the external instance cluster (enterprise edition only)
delete
/settings/external_instance_pg/databases/{name}
Drops a database Windmill created on the external instance cluster, refused while a data table, Ducklake catalog or pending fork cleanup uses it
post
/settings/list_custom_instance_pg_databases
Returns the set-up statuses of custom instance pg databases
get
/settings/datatable_roles
list the data table roles of one Windmill-managed Postgres cluster
post
/settings/datatable_roles
create a data table role on a Windmill-managed Postgres cluster
post
/settings/datatable_roles/{id}
rename a data table role or turn its login on and off
delete
/settings/datatable_roles/{id}
drop a data table role from the cluster and from every workspace that named it
post
/settings/setup_custom_instance_pg_database/{name}
Runs CREATE DATABASE on the Windmill Postgres and grants access to the custom_instance_user
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/instance_ui
get the instance-wide announcement banner, accent color and API base url
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
get
/settings/audit_logs_s3_status
get status of the audit-log object-store export cursor
post
/settings/audit_logs_s3_backfill
start an opt-in historical backfill of audit logs to object storage
get
/settings/audit_logs_s3_backfill_status
get status of the audit-log object-store historical backfill
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
get
/settings/offline_license_status
get cap-usage status for the currently-loaded offline license
get
/settings/instance_hash
per-instance binding hash for offline license issuance
post
/settings/customer_portal
create customer portal session
post
/saml/test_metadata
test metadata
get
/settings/list_global
list global settings
get
/settings/github_app_stale_webhooks
list git-sync repositories whose webhook still points at a previous receiver
get
/settings/instance_config
get full instance config (global settings + worker configs)
put
/settings/instance_config
update instance config (bulk upsert, no deletes). Empty or missing global_settings/worker_configs are skipped.
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
settings
4
sqs_trigger
8
teams
1
token
1
trash
5
trigger
3
user
65
variable
10
volume
4
websocket_trigger
8
worker
13
workspace
142
workspace_dependencies
5
workspace_integration
8
setting
Copy Markdown
Copied
Copy failed
Changes to Creates a database on the external instance cluster (enterprise edition only)
post
/settings/external_instance_pg/databases/{name}
Sep 29, 2026
54318efce822
Revision changes
info
endpoint added