/

/Windmill API

Changes Docs Sign in

Docs
History
Schema

Filter operations

agent_workers5

ai9

ai_evals14

amqp_trigger8

app43

asset10

audit2

azure_trigger13

capture7

concurrencyGroups4

config10

data_metric1

dbt3

documentation2

draft7

email_trigger8

favorite2

flow21

flow_conversations4

folder11

gcp_trigger14

Git Sync13

granular_acl3

group19

health2

helpers24

http_trigger9

hubPublish20

indexSearch7

input6

integration2

job104

kafka_trigger10

mcp1

mcp_oauth3

metrics3

mqtt_trigger8

native_trigger14

nats_trigger8

npm_proxy6

oauth13

oidc2

openapi2

path_autocomplete1

postgres_trigger20

raw_app1

resource31

schedule10

script37

service_logs2

setting63

post/settings/refresh_custom_instance_user_pwdRefreshes the passwords for the custom_instance_user and the custom_instance_replication_user (used by postgres triggers)
get/settings/external_instance_pg/statusReturns whether the external instance cluster is configured and how its last setup went
post/settings/external_instance_pg/setupSets 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/databasesLists 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_databasesReturns the set-up statuses of custom instance pg databases
get/settings/datatable_roleslist the data table roles of one Windmill-managed Postgres cluster
post/settings/datatable_rolescreate 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_uiget the instance-wide announcement banner, accent color and API base url
get/settings_u/ruff_configget instance ruff config (unauthenticated)
get/settings/localget local settings
get/settings/smtp_configuredwhether instance SMTP is configured
post/settings/test_smtptest smtp
post/settings/test_critical_channelstest critical channels
get/settings/critical_alertsGet all critical alerts
post/settings/critical_alerts/{id}/acknowledgeAcknowledge a critical alert
post/settings/critical_alerts/acknowledge_allAcknowledge all unacknowledged critical alerts
post/settings/test_license_keytest license key
post/settings/test_object_storage_configtest object storage config
get/settings/object_storage_usageget current or last object storage usage computation (null if never run)
post/settings/object_storage_usagestart a background computation of object storage usage by top-level folder
post/settings/run_log_cleanupstart a manual cleanup of expired logs from object storage
get/settings/log_cleanup_statusget status of the manual log cleanup task
get/settings/audit_logs_s3_statusget status of the audit-log object-store export cursor
post/settings/audit_logs_s3_backfillstart an opt-in historical backfill of audit logs to object storage
get/settings/audit_logs_s3_backfill_statusget status of the audit-log object-store historical backfill
post/settings/send_statssend stats
post/settings/restart_worker_group/{worker_group}restart worker group
get/settings/get_statsget telemetry stats with HMAC signature (EE only)
get/settings/latest_key_renewal_attemptget latest key renewal attempt
post/settings/renew_license_keyrenew license key
get/settings/offline_license_statusget cap-usage status for the currently-loaded offline license
get/settings/instance_hashper-instance binding hash for offline license issuance
post/settings/customer_portalcreate customer portal session
post/saml/test_metadatatest metadata
get/settings/list_globallist global settings
get/settings/github_app_stale_webhookslist git-sync repositories whose webhook still points at a previous receiver
get/settings/instance_configget full instance config (global settings + worker configs)
put/settings/instance_configupdate instance config (bulk upsert, no deletes). Empty or missing global_settings/worker_configs are skipped.
get/min_keep_alive_versionget minimum worker versions required to stay alive
get/.well-known/jwks.jsonget JWKS for Vault JWT authentication
post/settings/test_secret_backendtest secret backend connection (HashiCorp Vault)
post/settings/migrate_secrets_to_vaultmigrate secrets from database to HashiCorp Vault
post/settings/migrate_secrets_to_databasemigrate secrets from HashiCorp Vault to database
post/settings/test_azure_kv_backendtest Azure Key Vault connection
post/settings/migrate_secrets_to_azure_kvmigrate secrets from database to Azure Key Vault
post/settings/migrate_secrets_from_azure_kvmigrate secrets from Azure Key Vault to database
post/settings/test_aws_sm_backendtest connection to AWS Secrets Manager
post/settings/migrate_secrets_to_aws_smmigrate secrets from database to AWS Secrets Manager
post/settings/migrate_secrets_from_aws_smmigrate secrets from AWS Secrets Manager to database
get/w/{workspace}/workspaces/get_secondary_storage_namesget secondary storage names
get/w/{workspace}/workspaces/critical_alertsGet all critical alerts for this workspace
post/w/{workspace}/workspaces/critical_alerts/{id}/acknowledgeAcknowledge a critical alert for this workspace
post/w/{workspace}/workspaces/critical_alerts/acknowledge_allAcknowledge all unacknowledged critical alerts for this workspace
post/w/{workspace}/workspaces/critical_alerts/muteMute critical alert UI for this workspace
post/w/{workspace}/workspaces/public_app_rate_limitSet public app rate limit for this workspace

settings4

sqs_trigger8

teams1

token1

trash5

trigger3

user65

variable10

volume4

websocket_trigger8

worker13

workspace142

workspace_dependencies5

workspace_integration8

setting

Changes to whether instance SMTP is configured

get/settings/smtp_configured

Oct 13, 20264c05011ebfe0 Revision changes
- info
  endpoint added