/

/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

settings4

sqs_trigger8

teams1

token1

trash5

trigger3

user65

variable10

volume4

websocket_trigger8

worker13

workspace142

get/workspaces/listlist all workspaces visible to me
get/workspaces/allowed_domain_auto_inviteis domain allowed for auto invi
get/workspaces/userslist all workspaces visible to me with user info
post/workspaces/session_workspace_statusget the lifecycle status of workspaces referenced by client-side sessions
post/workspaces/session_workspace_retentionget the AI session retention of workspaces referenced by client-side sessions
get/w/{workspace}/workspaces/get_as_superadminget workspace as super admin (require to be super admin)
get/workspaces/list_as_superadminlist all workspaces as super admin (require to be super admin)
post/workspaces/createcreate workspace
post/w/{workspace}/workspaces/create_workspace_fork_branchcreate forked workspace branch with git sync
post/w/{workspace}/workspaces/create_forkcreate 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_workspaceattach an existing workspace as the dev workspace of this (prod) workspace
post/w/{workspace}/workspaces/detach_dev_workspacedetach the dev workspace from this (prod) workspace
get/w/{workspace}/workspaces/get_dev_workspacethis workspace's active canonical dev workspace, if any
post/workspaces/existsexists workspace
post/workspaces/exists_usernameexists username
post/w/{workspace}/github_app/tokenget 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_userinvite user to workspace
post/w/{workspace}/workspaces/add_useradd 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_accountcreate a service account
post/w/{workspace}/workspaces/delete_invitedelete user invite
post/w/{workspace}/workspaces/archivearchive workspace
post/workspaces/unarchive/{workspace}unarchive workspace
delete/workspaces/delete/{workspace}delete workspace (require super admin)
post/w/{workspace}/workspaces/leaveleave workspace
get/w/{workspace}/workspaces/get_workspace_nameget workspace name
post/w/{workspace}/workspaces/change_workspace_namechange workspace name
post/w/{workspace}/workspaces/change_workspace_idchange workspace id
post/w/{workspace}/workspaces/change_workspace_colorchange workspace id
post/w/{workspace}/workspaces/operator_settingsUpdate 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_inviteslist pending invites for a workspace
get/w/{workspace}/workspaces/get_public_settingsget public settings
get/w/{workspace}/workspaces/get_settingsget settings (admin only)
get/w/{workspace}/workspaces/get_deploy_toget the workspace this one deploys into (its fork parent)
get/w/{workspace}/remote_deploy/targetget the workspace's deploy target on another instance, and the caller's connection to it
post/w/{workspace}/remote_deploy/targetset or clear the workspace's deploy target on another instance
post/w/{workspace}/remote_deploy/connectstore the caller's own token for the remote deploy target
post/w/{workspace}/remote_deploy/disconnectforget the caller's token for the remote deploy target
get/w/{workspace}/workspaces/is_premiumget if workspace is premium
get/w/{workspace}/workspaces/billable_seatsget the billable seats of the workspace the plan is billed on
get/w/{workspace}/workspaces/premium_infoget premium info
get/w/{workspace}/workspaces/threshold_alertget threshold alert info
post/w/{workspace}/workspaces/threshold_alertset threshold alert info
post/w/{workspace}/workspaces/rebuild_dependency_maprebuild 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_amountsget dependents amounts for multiple imported paths
get/w/{workspace}/workspaces/get_dependency_mapget dependency map
post/w/{workspace}/workspaces/edit_slack_commandedit slack command
get/w/{workspace}/workspaces/slack_oauth_configget workspace slack oauth config
post/w/{workspace}/workspaces/slack_oauth_configset workspace slack oauth config
delete/w/{workspace}/workspaces/slack_oauth_configdelete workspace slack oauth config
post/w/{workspace}/workspaces/edit_teams_commandedit teams command
get/w/{workspace}/workspaces/available_teams_idslist available teams ids
get/w/{workspace}/workspaces/available_teams_channelslist available channels for a specific team
post/w/{workspace}/workspaces/connect_teamsconnect teams
post/w/{workspace}/workspaces/connect_slackconnect slack (non-interactive; pre-minted bot token)
post/w/{workspace}/workspaces/run_slack_message_test_jobrun a job that sends a message to Slack
post/w/{workspace}/workspaces/run_teams_message_test_jobrun a job that sends a message to Teams
post/w/{workspace}/workspaces/edit_auto_inviteedit auto invite
post/w/{workspace}/workspaces/edit_instance_groupsedit instance groups
post/w/{workspace}/workspaces/edit_webhookedit webhook
post/w/{workspace}/workspaces/edit_copilot_configedit copilot config
get/w/{workspace}/workspaces/get_copilot_settings_stateget copilot settings state
get/w/{workspace}/workspaces/get_copilot_infoget copilot info
post/w/{workspace}/workspaces/edit_error_handleredit error handler
post/w/{workspace}/workspaces/edit_success_handleredit success handler
post/w/{workspace}/workspaces/edit_large_file_storage_configedit large file storage settings
post/w/{workspace}/workspaces/edit_dbt_warehousesedit the workspace's dbt warehouses
get/w/{workspace}/workspaces/list_ducklakeslist ducklakes
get/w/{workspace}/workspaces/list_datatableslist 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}/planpreview the SQL an ownership or grant change would run (data table administrators only)
post/w/{workspace}/workspaces/datatable_acl/{datatable_name}/applyrun 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_schemaslist 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_tableslist tables of all connected Datatables
get/w/{workspace}/workspaces/get_datatable_table_schemaget one Datatable table schema
post/w/{workspace}/workspaces/edit_ducklake_configedit ducklake settings
post/w/{workspace}/workspaces/edit_datatable_configedit 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_migrationslist 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_databasecreate a new PostgreSQL database for a datatable
post/w/{workspace}/workspaces/drop_forked_datatable_databasesdrop forked datatable databases
post/w/{workspace}/workspaces/drop_forked_ducklake_namespacesdrop this fork workspace's ducklake namespaces (catalog metadata schemas + data files)
post/w/{workspace}/workspaces/import_pg_databaseimport a PostgreSQL database from source to target via pg_dump
post/w/{workspace}/workspaces/export_pg_schemaexport the schema of a PostgreSQL database
post/w/{workspace}/workspaces/get_datatable_full_schemaget the full schema of a datatable database as TableEditorValues
get/w/{workspace}/workspaces/git_sync_enabledCheck if git sync is available for this workspace
get/w/{workspace}/workspaces/git_sync_deploy_modeGet how local changes deploy to this workspace via git sync
post/w/{workspace}/workspaces/edit_git_sync_configedit workspace git sync settings
post/w/{workspace}/workspaces/edit_git_sync_repositoryadd or update individual git sync repository
delete/w/{workspace}/workspaces/delete_git_sync_repositorydelete individual git sync repository
post/w/{workspace}/workspaces/edit_deploy_ui_configedit workspace deploy ui settings
post/w/{workspace}/workspaces/edit_default_appedit default app for workspace
post/w/{workspace}/workspaces/edit_guest_accessenable or disable guest sessions for this workspace
post/w/{workspace}/workspaces/edit_add_admins_and_developers_to_forkschoose whether new forks of this workspace start with its admins and developers
post/w/{workspace}/workspaces/edit_guest_jwt_keyset the key guest JWTs are verified against for this workspace
get/w/{workspace}/workspaces/guest_usagethe instance's standing against the guest allowance
get/w/{workspace}/workspaces/default_scriptsget default scripts for workspace
post/w/{workspace}/workspaces/default_scriptsedit default scripts for workspace
post/w/{workspace}/workspaces/set_environment_variableset environment variable
get/w/{workspace}/workspaces/encryption_keyretrieves the encryption key for this workspace
post/w/{workspace}/workspaces/encryption_keyupdate the encryption key for this workspace
get/w/{workspace}/workspaces/default_appget default app for workspace
get/w/{workspace}/workspaces/usageget usage
get/w/{workspace}/workspaces/used_triggersget used triggers
get/w/{workspace}/workspaces/protection_ruleslist all protection rules for a workspace
post/w/{workspace}/workspaces/protection_rulescreate 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_deployerslist users eligible to be deployment request assignees
get/w/{workspace}/deployment_request/openget the currently open deployment request for this fork
post/w/{workspace}/deployment_requestcreate a new deployment request
post/w/{workspace}/deployment_request/{id}/cancelcancel an open deployment request
post/w/{workspace}/deployment_request/{id}/close_mergedclose a deployment request after a successful merge
post/w/{workspace}/deployment_request/{id}/commentappend a comment to an open deployment request
post/w/{workspace}/workspaces/log_feature_usagelog anonymous feature usage telemetry events
get/w/{workspace}/workspaces/cloud_quotasget cloud quota usage and limits for workspace
post/w/{workspace}/workspaces/prune_versionsprune old versions of scripts, flows, apps, or resources
get/w/{workspace}/workspaces/list_ws_specificlist all workspace-specific items
get/w/{workspace}/workspaces/list_ws_specific_versionslist workspace ids that have a version of the given item
post/w/{workspace}/workspaces/set_ws_specificmark or unmark an item as workspace-specific
get/w/{workspace}/shared_ui/getget the workspace shared UI folder (full content)
get/w/{workspace}/shared_ui/listlist paths/sizes of the workspace shared UI folder
get/w/{workspace}/shared_ui/versionget the current version of the workspace shared UI folder
put/w/{workspace}/shared_uireplace the workspace shared UI folder (admin only)

workspace_dependencies5

workspace_integration8

workspace

Changes to edit error handler

post/w/{workspace}/workspaces/edit_error_handler

Jul 24, 202639f6b42d1670 Revision changes
- info
  added the new optional request property ////