Windmill

Windmill Workspace API

The workspace API from Windmill — 96 operation(s) for workspace.

GitHub OpenAPI

Operations 103

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 #
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 #
POST /workspaces/exists Exists Workspace #
POST /workspaces/exists_username Exists Username #
POST /w/{workspace}/github_app/token Get Github App Token #
POST /w/{workspace}/workspaces/invite_user Invite User to Workspace #
POST /w/{workspace}/workspaces/add_user Add User to Workspace #
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/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 Deploy to #
GET /w/{workspace}/workspaces/is_premium Get if Workspace is Premium #
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_deploy_to Edit Deploy to #
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 #
GET /w/{workspace}/workspaces/list_ducklakes List Ducklakes #
GET /w/{workspace}/workspaces/list_datatables List Datatables #
GET /w/{workspace}/workspaces/list_datatable_schemas List Schemas of All Connected Datatables #
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/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/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 #
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/default_scripts Edit Default Scripts for Workspace #
GET /w/{workspace}/workspaces/default_scripts Get 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_chat Log AI Chat Message #
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, or Apps #
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) #

Documentation

📖
Documentation
https://www.windmill.dev/docs/intro
📖
GettingStarted
https://www.windmill.dev/docs/getting_started/how_to_use_windmill
📖
Authentication
https://www.windmill.dev/docs/core_concepts/authentification

Specifications

⚙
OpenAPI
https://artifacts.apis.io/windmill/openapi/windmill-workspace-api-openapi.yml

Other Resources

🔗
APIReferenceDocumentation
https://app.windmill.dev/openapi.html
🔗
HTTPRoutes
https://www.windmill.dev/docs/core_concepts/http_routing
🔗
CLI
https://www.windmill.dev/docs/advanced/cli
🔗
SelfHosting
https://www.windmill.dev/docs/advanced/self_host
🔗
TypeScriptSDK
https://www.windmill.dev/docs/advanced/clients/ts_client
🔗
PythonSDK
https://www.windmill.dev/docs/advanced/clients/python_client
🔗
SpectralRules
https://artifacts.apis.io/windmill/rules/windmill-api-rules.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/windmill:windmill-workspace-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

windmill-workspace-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.694.0
  title: Windmill Workspace API
  contact:
    name: Windmill Team
    email: contact@windmill.dev
    url: https://windmill.dev
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://windmill.dev/img/windmill.svg
servers:
- url: /api
security:
- bearerAuth: []
- cookieAuth: []
tags:


# --- truncated at 32 KB (103 KB total) ---
# Full source: https://artifacts.apis.io/windmill/openapi/windmill-workspace-api-openapi.yml