/
WI
windmill
/
Windmill API
Search skmtc…
⌘K
Changes
Docs
Sign in
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
2
openapi
2
path_autocomplete
1
postgres_trigger
20
raw_app
1
resource
31
schedule
10
script
37
service_logs
2
setting
63
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
get
/workspaces/list
list all workspaces visible to me
get
/workspaces/allowed_domain_auto_invite
is domain allowed for auto invi
get
/workspaces/users
list all workspaces visible to me with user info
post
/workspaces/session_workspace_status
get the lifecycle status of workspaces referenced by client-side sessions
post
/workspaces/session_workspace_retention
get the AI session retention of workspaces referenced by client-side sessions
get
/w/{workspace}/workspaces/get_as_superadmin
get workspace as super admin (require to be super admin)
get
/workspaces/list_as_superadmin
list all workspaces as super admin (require to be super admin)
post
/workspaces/create
create workspace
post
/w/{workspace}/workspaces/create_workspace_fork_branch
create forked workspace branch with git sync
post
/w/{workspace}/workspaces/create_fork
create forked workspace
get
/w/{workspace}/workspaces/fork_creation_status/{creation_id}
get the status of a fork created in the background
post
/w/{workspace}/workspaces/attach_dev_workspace
attach an existing workspace as the dev workspace of this (prod) workspace
post
/w/{workspace}/workspaces/detach_dev_workspace
detach the dev workspace from this (prod) workspace
get
/w/{workspace}/workspaces/get_dev_workspace
this workspace's active canonical dev workspace, if any
post
/workspaces/exists
exists workspace
post
/workspaces/exists_username
exists username
post
/w/{workspace}/github_app/token
get the git credential for a git-sync job (GitHub App token, or the credential stored for the repository)
get
/w/{workspace}/github_app/repo_archive/{path}
download a gzipped tarball of a GitHub App repository
post
/w/{workspace}/workspaces/invite_user
invite user to workspace
post
/w/{workspace}/workspaces/add_user
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
/w/{workspace}/workspaces/create_service_account
create a service account
post
/w/{workspace}/workspaces/delete_invite
delete user invite
post
/w/{workspace}/workspaces/archive
archive workspace
post
/workspaces/unarchive/{workspace}
unarchive workspace
delete
/workspaces/delete/{workspace}
delete workspace (require super admin)
post
/w/{workspace}/workspaces/leave
leave workspace
get
/w/{workspace}/workspaces/get_workspace_name
get workspace name
post
/w/{workspace}/workspaces/change_workspace_name
change workspace name
post
/w/{workspace}/workspaces/change_workspace_id
change workspace id
post
/w/{workspace}/workspaces/change_workspace_color
change workspace id
post
/w/{workspace}/workspaces/operator_settings
Update operator settings for a workspace
get
/w/{workspace}/workspaces/compare/{target_workspace_id}
Compare two workspaces
post
/w/{workspace}/workspaces/seed_full_diff/{target_workspace_id}
Seed the diff candidate set against an arbitrary workspace
post
/w/{workspace}/workspaces/reset_diff_tally/{fork_workspace_id}
Resets the ahead and behind deployement counter after a deployement
get
/w/{workspace}/workspaces/list_pending_invites
list pending invites for a workspace
get
/w/{workspace}/workspaces/get_public_settings
get public settings
get
/w/{workspace}/workspaces/get_settings
get settings (admin only)
get
/w/{workspace}/workspaces/get_deploy_to
get the workspace this one deploys into (its fork parent)
get
/w/{workspace}/remote_deploy/target
get the workspace's deploy target on another instance, and the caller's connection to it
post
/w/{workspace}/remote_deploy/target
set or clear the workspace's deploy target on another instance
post
/w/{workspace}/remote_deploy/connect
store the caller's own token for the remote deploy target
post
/w/{workspace}/remote_deploy/disconnect
forget the caller's token for the remote deploy target
get
/w/{workspace}/workspaces/is_premium
get if workspace is premium
get
/w/{workspace}/workspaces/billable_seats
get the billable seats of the workspace the plan is billed on
get
/w/{workspace}/workspaces/premium_info
get premium info
get
/w/{workspace}/workspaces/threshold_alert
get threshold alert info
post
/w/{workspace}/workspaces/threshold_alert
set threshold alert info
post
/w/{workspace}/workspaces/rebuild_dependency_map
rebuild dependency map
get
/w/{workspace}/workspaces/get_dependents/{imported_path}
get dependents of an imported path
get
/w/{workspace}/workspaces/get_imports/{importer_path}
get script imports for an importer path
post
/w/{workspace}/workspaces/get_dependents_amounts
get dependents amounts for multiple imported paths
get
/w/{workspace}/workspaces/get_dependency_map
get dependency map
post
/w/{workspace}/workspaces/edit_slack_command
edit slack command
get
/w/{workspace}/workspaces/slack_oauth_config
get workspace slack oauth config
post
/w/{workspace}/workspaces/slack_oauth_config
set workspace slack oauth config
delete
/w/{workspace}/workspaces/slack_oauth_config
delete workspace slack oauth config
post
/w/{workspace}/workspaces/edit_teams_command
edit teams command
get
/w/{workspace}/workspaces/available_teams_ids
list available teams ids
get
/w/{workspace}/workspaces/available_teams_channels
list available channels for a specific team
post
/w/{workspace}/workspaces/connect_teams
connect teams
post
/w/{workspace}/workspaces/connect_slack
connect slack (non-interactive; pre-minted bot token)
post
/w/{workspace}/workspaces/run_slack_message_test_job
run a job that sends a message to Slack
post
/w/{workspace}/workspaces/run_teams_message_test_job
run a job that sends a message to Teams
post
/w/{workspace}/workspaces/edit_auto_invite
edit auto invite
post
/w/{workspace}/workspaces/edit_instance_groups
edit instance groups
post
/w/{workspace}/workspaces/edit_webhook
edit webhook
post
/w/{workspace}/workspaces/edit_copilot_config
edit copilot config
get
/w/{workspace}/workspaces/get_copilot_settings_state
get copilot settings state
get
/w/{workspace}/workspaces/get_copilot_info
get copilot info
post
/w/{workspace}/workspaces/edit_error_handler
edit error handler
post
/w/{workspace}/workspaces/edit_success_handler
edit success handler
post
/w/{workspace}/workspaces/edit_large_file_storage_config
edit large file storage settings
post
/w/{workspace}/workspaces/edit_dbt_warehouses
edit the workspace's dbt warehouses
get
/w/{workspace}/workspaces/list_ducklakes
list ducklakes
get
/w/{workspace}/workspaces/list_datatables
list Datatables
get
/w/{workspace}/workspaces/datatable_permissions/{datatable_name}
get who may connect to a data table as which role
post
/w/{workspace}/workspaces/datatable_permissions/{datatable_name}
set who may connect to a data table as which role
get
/w/{workspace}/workspaces/datatable_acl/{datatable_name}
read the owner and grants of an instance data table's database, schema or table
post
/w/{workspace}/workspaces/datatable_acl/{datatable_name}/plan
preview the SQL an ownership or grant change would run (data table administrators only)
post
/w/{workspace}/workspaces/datatable_acl/{datatable_name}/apply
run an ownership or grant change exactly as planned (data table administrators only)
get
/w/{workspace}/workspaces/datatable_usable_roles/{datatable_name}
list the data table roles the caller may connect as
get
/w/{workspace}/workspaces/list_datatable_schemas
list schemas of all connected Datatables
get
/w/{workspace}/workspaces/test_datatable_connection/{datatable_name}
check what the data table's database lets its role do
get
/w/{workspace}/workspaces/list_datatable_tables
list tables of all connected Datatables
get
/w/{workspace}/workspaces/get_datatable_table_schema
get one Datatable table schema
post
/w/{workspace}/workspaces/edit_ducklake_config
edit ducklake settings
post
/w/{workspace}/workspaces/edit_datatable_config
edit datatable settings
post
/w/{workspace}/workspaces/run_datatable_migrations/{datatable_name}
run pending datatable migrations against a datatable
post
/w/{workspace}/workspaces/rollback_datatable_migrations/{datatable_name}
roll back the most recently applied migration on a datatable
get
/w/{workspace}/workspaces/list_datatable_migrations
list datatable migrations for a workspace
get
/w/{workspace}/workspaces/datatable_migrations_status/{datatable_name}
list a datatable's migrations with their applied status
post
/w/{workspace}/workspaces/enable_datatable_migrations/{datatable_name}
opt a datatable in to migrations (admins / super admins only)
post
/w/{workspace}/workspaces/disable_datatable_migrations/{datatable_name}
opt a datatable out of migrations, deleting all of them (admins / super admins only)
post
/w/{workspace}/workspaces/create_datatable_migration/{datatable_name}
create a single datatable migration (version generated server-side)
delete
/w/{workspace}/workspaces/delete_datatable_migration/{datatable_name}/{timestamp}
delete a single datatable migration definition
post
/w/{workspace}/workspaces/upsert_datatable_migration/{datatable_name}
insert or update a single datatable migration at an explicit version
post
/w/{workspace}/workspaces/generate_initial_datatable_migration/{datatable_name}
snapshot the current schema as an already-installed initial migration
post
/w/{workspace}/workspaces/create_pg_database
create a new PostgreSQL database for a datatable
post
/w/{workspace}/workspaces/drop_forked_datatable_databases
drop forked datatable databases
post
/w/{workspace}/workspaces/drop_forked_ducklake_namespaces
drop this fork workspace's ducklake namespaces (catalog metadata schemas + data files)
post
/w/{workspace}/workspaces/import_pg_database
import a PostgreSQL database from source to target via pg_dump
post
/w/{workspace}/workspaces/export_pg_schema
export the schema of a PostgreSQL database
post
/w/{workspace}/workspaces/get_datatable_full_schema
get the full schema of a datatable database as TableEditorValues
get
/w/{workspace}/workspaces/git_sync_enabled
Check if git sync is available for this workspace
get
/w/{workspace}/workspaces/git_sync_deploy_mode
Get how local changes deploy to this workspace via git sync
post
/w/{workspace}/workspaces/edit_git_sync_config
edit workspace git sync settings
post
/w/{workspace}/workspaces/edit_git_sync_repository
add or update individual git sync repository
delete
/w/{workspace}/workspaces/delete_git_sync_repository
delete individual git sync repository
post
/w/{workspace}/workspaces/edit_deploy_ui_config
edit workspace deploy ui settings
post
/w/{workspace}/workspaces/edit_default_app
edit default app for workspace
post
/w/{workspace}/workspaces/edit_guest_access
enable or disable guest sessions for this workspace
post
/w/{workspace}/workspaces/edit_add_admins_and_developers_to_forks
choose whether new forks of this workspace start with its admins and developers
post
/w/{workspace}/workspaces/edit_guest_jwt_key
set the key guest JWTs are verified against for this workspace
get
/w/{workspace}/workspaces/guest_usage
the instance's standing against the guest allowance
get
/w/{workspace}/workspaces/default_scripts
get default scripts for workspace
post
/w/{workspace}/workspaces/default_scripts
edit default scripts for workspace
post
/w/{workspace}/workspaces/set_environment_variable
set environment variable
get
/w/{workspace}/workspaces/encryption_key
retrieves the encryption key for this workspace
post
/w/{workspace}/workspaces/encryption_key
update the encryption key for this workspace
get
/w/{workspace}/workspaces/default_app
get default app for workspace
get
/w/{workspace}/workspaces/usage
get usage
get
/w/{workspace}/workspaces/used_triggers
get used triggers
get
/w/{workspace}/workspaces/protection_rules
list all protection rules for a workspace
post
/w/{workspace}/workspaces/protection_rules
create a new protection rule
post
/w/{workspace}/workspaces/protection_rules/{rule_name}
update an existing protection rule
delete
/w/{workspace}/workspaces/protection_rules/{rule_name}
delete a protection rule
get
/w/{workspace}/deployment_request/eligible_deployers
list users eligible to be deployment request assignees
get
/w/{workspace}/deployment_request/open
get the currently open deployment request for this fork
post
/w/{workspace}/deployment_request
create a new deployment request
post
/w/{workspace}/deployment_request/{id}/cancel
cancel an open deployment request
post
/w/{workspace}/deployment_request/{id}/close_merged
close a deployment request after a successful merge
post
/w/{workspace}/deployment_request/{id}/comment
append a comment to an open deployment request
post
/w/{workspace}/workspaces/log_feature_usage
log anonymous feature usage telemetry events
get
/w/{workspace}/workspaces/cloud_quotas
get cloud quota usage and limits for workspace
post
/w/{workspace}/workspaces/prune_versions
prune old versions of scripts, flows, apps, or resources
get
/w/{workspace}/workspaces/list_ws_specific
list all workspace-specific items
get
/w/{workspace}/workspaces/list_ws_specific_versions
list workspace ids that have a version of the given item
post
/w/{workspace}/workspaces/set_ws_specific
mark or unmark an item as workspace-specific
get
/w/{workspace}/shared_ui/get
get the workspace shared UI folder (full content)
get
/w/{workspace}/shared_ui/list
list paths/sizes of the workspace shared UI folder
get
/w/{workspace}/shared_ui/version
get the current version of the workspace shared UI folder
put
/w/{workspace}/shared_ui
replace the workspace shared UI folder (admin only)
workspace_dependencies
5
workspace_integration
8
workspace
Copy Markdown
Copied
Copy failed
Changes to get premium info
get
/w/{workspace}/workspaces/premium_info
Oct 6, 2026
f80d538c89dc
Revision changes
info
added the optional property
is_canceled
to the response with the
200
status