/
WI
windmill
/
Windmill API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 2h ago · Updated 7h ago
View markdown
windmill
Windmill API
get
get usage
latest
OpenAPI 3.0.3
Apache 2.0
raw.githubusercontent.com
2026-08-16
826
354
1004.6 KB
c3a7465c46bb
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
6
oauth
13
oidc
1
openapi
2
path_autocomplete
1
postgres_trigger
20
raw_app
1
resource
28
schedule
10
script
36
service_logs
2
setting
52
settings
4
sqs_trigger
8
teams
1
token
1
trigger
3
user
57
variable
10
volume
4
websocket_trigger
8
worker
10
workspace
128
get
list all workspaces visible to me
get
is domain allowed for auto invi
get
list all workspaces visible to me with user info
post
get the lifecycle status of workspaces referenced by client-side sessions
get
get workspace as super admin (require to be super admin)
get
list all workspaces as super admin (require to be super admin)
post
create workspace
post
create forked workspace branch with git sync
post
create forked workspace
post
attach an existing workspace as the dev workspace of this (prod) workspace
post
detach the dev workspace from this (prod) workspace
get
this workspace's active canonical dev workspace, if any
post
exists workspace
post
exists username
post
get github app token
post
invite user to workspace
post
add user to workspace (require admin privilege, except for the creator of a fork adding a developer/admin of its parent workspace as a developer of the fork)
post
create a service account
post
delete user invite
post
archive workspace
post
unarchive workspace
delete
delete workspace (require super admin)
post
leave workspace
get
get workspace name
post
change workspace name
post
change workspace id
post
change workspace id
post
Update operator settings for a workspace
get
Compare two workspaces
post
Seed the diff candidate set against an arbitrary workspace
post
Resets the ahead and behind deployement counter after a deployement
get
list pending invites for a workspace
get
get public settings
get
get settings (admin only)
get
get the workspace this one deploys into (its fork parent)
get
get if workspace is premium
get
get premium info
get
get threshold alert info
post
set threshold alert info
post
rebuild dependency map
get
get dependents of an imported path
get
get script imports for an importer path
post
get dependents amounts for multiple imported paths
get
get dependency map
post
edit slack command
get
get workspace slack oauth config
post
set workspace slack oauth config
delete
delete workspace slack oauth config
post
edit teams command
get
list available teams ids
get
list available channels for a specific team
post
connect teams
post
connect slack (non-interactive; pre-minted bot token)
post
run a job that sends a message to Slack
post
run a job that sends a message to Teams
post
edit auto invite
post
edit instance groups
post
edit webhook
post
edit copilot config
get
get copilot settings state
get
get copilot info
post
edit error handler
post
edit success handler
post
edit large file storage settings
post
edit the workspace's dbt warehouses
get
list ducklakes
get
list Datatables
get
list schemas of all connected Datatables
get
check what the data table's database lets its role do
get
list tables of all connected Datatables
get
get one Datatable table schema
post
edit ducklake settings
post
edit datatable settings
post
run pending datatable migrations against a datatable
post
roll back the most recently applied migration on a datatable
get
list datatable migrations for a workspace
get
list a datatable's migrations with their applied status
post
opt a datatable in to migrations (admins / super admins only)
post
opt a datatable out of migrations, deleting all of them (admins / super admins only)
post
create a single datatable migration (version generated server-side)
delete
delete a single datatable migration definition
post
insert or update a single datatable migration at an explicit version
post
snapshot the current schema as an already-installed initial migration
post
create a new PostgreSQL database for a datatable
post
drop forked datatable databases
post
drop this fork workspace's ducklake namespaces (catalog metadata schemas + data files)
post
import a PostgreSQL database from source to target via pg_dump
post
export the schema of a PostgreSQL database
post
get the full schema of a datatable database as TableEditorValues
get
Check if git sync is available for this workspace
get
Get how local changes deploy to this workspace via git sync
post
edit workspace git sync settings
post
add or update individual git sync repository
delete
delete individual git sync repository
post
edit workspace deploy ui settings
post
edit default app for workspace
get
get default scripts for workspace
post
edit default scripts for workspace
post
set environment variable
get
retrieves the encryption key for this workspace
post
update the encryption key for this workspace
get
get default app for workspace
get
get usage
get
get used triggers
get
list all protection rules for a workspace
post
create a new protection rule
post
update an existing protection rule
delete
delete a protection rule
get
list users eligible to be deployment request assignees
get
get the currently open deployment request for this fork
post
create a new deployment request
post
cancel an open deployment request
post
close a deployment request after a successful merge
post
append a comment to an open deployment request
post
log anonymous feature usage telemetry events
get
get cloud quota usage and limits for workspace
post
prune old versions of scripts, flows, apps, or resources
get
list all workspace-specific items
get
list workspace ids that have a version of the given item
post
mark or unmark an item as workspace-specific
get
get the workspace shared UI folder (full content)
get
list paths/sizes of the workspace shared UI folder
get
get the current version of the workspace shared UI folder
put
replace the workspace shared UI folder (admin only)
get
list the workspace AI chat skills (name + description only)
get
get a workspace AI chat skill including its instructions
post
upsert workspace AI chat skills (admin only)
delete
delete a workspace AI chat skill (admin only)
workspace_dependencies
5
workspace_integration
8
workspace
get usage
get
/w/{workspace}/workspaces/usage
Path parameters
workspace
string
required
Response
usage