Skip to main content Module workspace_api Copy item path Source AddUserError struct for typed errors of method add_user ArchiveWorkspaceError struct for typed errors of method archive_workspace AttachDevWorkspaceError struct for typed errors of method attach_dev_workspace CancelDeploymentRequestError struct for typed errors of method cancel_deployment_request ChangeWorkspaceColorError struct for typed errors of method change_workspace_color ChangeWorkspaceIdError struct for typed errors of method change_workspace_id ChangeWorkspaceNameError struct for typed errors of method change_workspace_name CloseDeploymentRequestMergedError struct for typed errors of method close_deployment_request_merged CompareWorkspacesError struct for typed errors of method compare_workspaces ConnectSlackError struct for typed errors of method connect_slack ConnectTeamsError struct for typed errors of method connect_teams CreateDatatableMigrationError struct for typed errors of method create_datatable_migration CreateDeploymentRequestCommentError struct for typed errors of method create_deployment_request_comment CreateDeploymentRequestError struct for typed errors of method create_deployment_request CreatePgDatabaseError struct for typed errors of method create_pg_database CreateProtectionRuleError struct for typed errors of method create_protection_rule CreateServiceAccountError struct for typed errors of method create_service_account CreateWorkspaceError struct for typed errors of method create_workspace CreateWorkspaceForkError struct for typed errors of method create_workspace_fork CreateWorkspaceForkGitBranchError struct for typed errors of method create_workspace_fork_git_branch DeleteDatatableMigrationError struct for typed errors of method delete_datatable_migration DeleteGitSyncRepositoryError struct for typed errors of method delete_git_sync_repository DeleteInviteError struct for typed errors of method delete_invite DeleteProtectionRuleError struct for typed errors of method delete_protection_rule DeleteWorkspaceError struct for typed errors of method delete_workspace DeleteWorkspaceSlackOauthConfigError struct for typed errors of method delete_workspace_slack_oauth_config DetachDevWorkspaceError struct for typed errors of method detach_dev_workspace DisableDatatableMigrationsError struct for typed errors of method disable_datatable_migrations DropForkedDatatableDatabasesError struct for typed errors of method drop_forked_datatable_databases DropForkedDucklakeNamespacesError struct for typed errors of method drop_forked_ducklake_namespaces EditAutoInviteError struct for typed errors of method edit_auto_invite EditCopilotConfigError struct for typed errors of method edit_copilot_config EditDataTableConfigError struct for typed errors of method edit_data_table_config EditDbtWarehousesError struct for typed errors of method edit_dbt_warehouses EditDefaultScriptsError struct for typed errors of method edit_default_scripts EditDucklakeConfigError struct for typed errors of method edit_ducklake_config EditErrorHandlerError struct for typed errors of method edit_error_handler EditGitSyncRepositoryError struct for typed errors of method edit_git_sync_repository EditGuestAccessError struct for typed errors of method edit_guest_access EditGuestJwtKeyError struct for typed errors of method edit_guest_jwt_key EditInstanceGroupsError struct for typed errors of method edit_instance_groups EditLargeFileStorageConfigError struct for typed errors of method edit_large_file_storage_config EditSlackCommandError struct for typed errors of method edit_slack_command EditSuccessHandlerError struct for typed errors of method edit_success_handler EditTeamsCommandError struct for typed errors of method edit_teams_command EditWebhookError struct for typed errors of method edit_webhook EditWorkspaceDefaultAppError struct for typed errors of method edit_workspace_default_app EditWorkspaceDeployUiSettingsError struct for typed errors of method edit_workspace_deploy_ui_settings EditWorkspaceGitSyncConfigError struct for typed errors of method edit_workspace_git_sync_config EnableDatatableMigrationsError struct for typed errors of method enable_datatable_migrations ExistsUsernameError struct for typed errors of method exists_username ExistsWorkspaceError struct for typed errors of method exists_workspace ExportPgSchemaError struct for typed errors of method export_pg_schema GenerateInitialDatatableMigrationError struct for typed errors of method generate_initial_datatable_migration GetBillableSeatsError struct for typed errors of method get_billable_seats GetCloudQuotasError struct for typed errors of method get_cloud_quotas GetCopilotInfoError struct for typed errors of method get_copilot_info GetCopilotSettingsStateError struct for typed errors of method get_copilot_settings_state GetDataTableTableSchemaError struct for typed errors of method get_data_table_table_schema GetDatatableFullSchemaError struct for typed errors of method get_datatable_full_schema GetDatatableMigrationsStatusError struct for typed errors of method get_datatable_migrations_status GetDefaultScriptsError struct for typed errors of method get_default_scripts GetDependencyMapError struct for typed errors of method get_dependency_map GetDependentsAmountsError struct for typed errors of method get_dependents_amounts GetDependentsError struct for typed errors of method get_dependents GetDeployToError struct for typed errors of method get_deploy_to GetDevWorkspaceError struct for typed errors of method get_dev_workspace GetGitSyncDeployModeError struct for typed errors of method get_git_sync_deploy_mode GetGitSyncEnabledError struct for typed errors of method get_git_sync_enabled GetGithubAppRepoArchiveError struct for typed errors of method get_github_app_repo_archive GetGithubAppTokenError struct for typed errors of method get_github_app_token GetGuestUsageError struct for typed errors of method get_guest_usage GetImportsError struct for typed errors of method get_imports GetIsPremiumError struct for typed errors of method get_is_premium GetOpenDeploymentRequestError struct for typed errors of method get_open_deployment_request GetPremiumInfoError struct for typed errors of method get_premium_info GetPublicSettingsError struct for typed errors of method get_public_settings GetSessionWorkspaceStatusError struct for typed errors of method get_session_workspace_status GetSettingsError struct for typed errors of method get_settings GetSharedUiError struct for typed errors of method get_shared_ui GetSharedUiVersionError struct for typed errors of method get_shared_ui_version GetThresholdAlertError struct for typed errors of method get_threshold_alert GetUsedTriggersError struct for typed errors of method get_used_triggers GetWorkspaceAsSuperAdminError struct for typed errors of method get_workspace_as_super_admin GetWorkspaceDefaultAppError struct for typed errors of method get_workspace_default_app GetWorkspaceEncryptionKeyError struct for typed errors of method get_workspace_encryption_key GetWorkspaceNameError struct for typed errors of method get_workspace_name GetWorkspaceSlackOauthConfigError struct for typed errors of method get_workspace_slack_oauth_config GetWorkspaceUsageError struct for typed errors of method get_workspace_usage ImportPgDatabaseError struct for typed errors of method import_pg_database InviteUserError struct for typed errors of method invite_user IsDomainAllowedError struct for typed errors of method is_domain_allowed LeaveWorkspaceError struct for typed errors of method leave_workspace ListAvailableTeamsChannelsError struct for typed errors of method list_available_teams_channels ListAvailableTeamsIdsError struct for typed errors of method list_available_teams_ids ListDataTableSchemasError struct for typed errors of method list_data_table_schemas ListDataTableTablesError struct for typed errors of method list_data_table_tables ListDataTablesError struct for typed errors of method list_data_tables ListDatatableMigrationsError struct for typed errors of method list_datatable_migrations ListDeploymentRequestEligibleDeployersError struct for typed errors of method list_deployment_request_eligible_deployers ListDucklakesError struct for typed errors of method list_ducklakes ListPendingInvitesError struct for typed errors of method list_pending_invites ListProtectionRulesError struct for typed errors of method list_protection_rules ListSharedUiError struct for typed errors of method list_shared_ui ListUserWorkspacesError struct for typed errors of method list_user_workspaces ListWorkspacesAsSuperAdminError struct for typed errors of method list_workspaces_as_super_admin ListWorkspacesError struct for typed errors of method list_workspaces ListWsSpecificError struct for typed errors of method list_ws_specific ListWsSpecificVersionsError struct for typed errors of method list_ws_specific_versions LogFeatureUsageError struct for typed errors of method log_feature_usage PruneVersionsError struct for typed errors of method prune_versions RebuildDependencyMapError struct for typed errors of method rebuild_dependency_map ResetDiffTallyError struct for typed errors of method reset_diff_tally RollbackDatatableMigrationsError struct for typed errors of method rollback_datatable_migrations RunDatatableMigrationsError struct for typed errors of method run_datatable_migrations RunSlackMessageTestJobError struct for typed errors of method run_slack_message_test_job RunTeamsMessageTestJobError struct for typed errors of method run_teams_message_test_job SeedFullDiffScanError struct for typed errors of method seed_full_diff_scan SetEnvironmentVariableError struct for typed errors of method set_environment_variable SetThresholdAlertError struct for typed errors of method set_threshold_alert SetWorkspaceEncryptionKeyError struct for typed errors of method set_workspace_encryption_key SetWorkspaceSlackOauthConfigError struct for typed errors of method set_workspace_slack_oauth_config SetWsSpecificError struct for typed errors of method set_ws_specific TestDataTableConnectionError struct for typed errors of method test_data_table_connection UnarchiveWorkspaceError struct for typed errors of method unarchive_workspace UpdateOperatorSettingsError struct for typed errors of method update_operator_settings UpdateProtectionRuleError struct for typed errors of method update_protection_rule UpdateSharedUiError struct for typed errors of method update_shared_ui UpsertDatatableMigrationError struct for typed errors of method upsert_datatable_migration add_user archive_workspace attach_dev_workspace cancel_deployment_request change_workspace_color change_workspace_id change_workspace_name close_deployment_request_merged Called by the UI after the deploy loop completes. Closes the request and marks every comment obsolete. Idempotent. compare_workspaces Compares the current workspace with a target workspace to find differences in scripts, flows, apps, resources, and variables. Returns information about items that are ahead, behind, or in conflict. connect_slack connect_teams create_datatable_migration create_deployment_request create_deployment_request_comment create_pg_database create_protection_rule create_service_account create_workspace create_workspace_fork create_workspace_fork_git_branch delete_datatable_migration delete_git_sync_repository delete_invite delete_protection_rule delete_workspace delete_workspace_slack_oauth_config detach_dev_workspace disable_datatable_migrations drop_forked_datatable_databases drop_forked_ducklake_namespaces edit_auto_invite edit_copilot_config edit_data_table_config edit_dbt_warehouses edit_default_scripts edit_ducklake_config edit_error_handler edit_git_sync_repository edit_guest_access Guests are people the identity provider authenticates who have no Windmill account; the guest app execution mode admits them. Off by default. Re-read where a guest session is minted and at the auth door on every guest request, so turning it off takes effect immediately, for sessions already issued and for apps whose policy already says guest. edit_guest_jwt_key A guest JWT (jwt_guest_) is minted by the embedding customer’s own backend and verified against this key: a PEM public key (RS/ES family, HS* refused) or a JWKS URL, at most one. Both empty clears the workspace key; off cloud, verification then falls back to the instance issuer (JWT_EXT_JWKS_URL) if one is set, else no guest JWT is accepted (guest_access_enabled is the on/off switch). Workspace-admin gated. The key is validated before it is stored. edit_instance_groups edit_large_file_storage_config edit_slack_command edit_success_handler edit_teams_command edit_webhook edit_workspace_default_app edit_workspace_deploy_ui_settings edit_workspace_git_sync_config enable_datatable_migrations exists_username exists_workspace export_pg_schema generate_initial_datatable_migration get_billable_seats get_cloud_quotas get_copilot_info get_copilot_settings_state get_data_table_table_schema get_datatable_full_schema get_datatable_migrations_status get_default_scripts get_dependency_map get_dependents get_dependents_amounts get_deploy_to get_dev_workspace get_git_sync_deploy_mode get_git_sync_enabled get_github_app_repo_archive get_github_app_token get_guest_usage Instance-wide, since a licence is per instance and one email is one guest however many workspaces it opens. Read by workspace admins and app publishers to see how close the cap (Community and Pro) or the meter (Enterprise) is. get_imports get_is_premium get_open_deployment_request get_premium_info get_public_settings Returns the subset of workspace settings safe to expose to any workspace member. The full settings struct is admin-only via getSettings. get_session_workspace_status get_settings Returns the full workspace settings including admin-managed integration credentials. Admin-only — non-admin callers should use getPublicSettings. get_shared_ui get_shared_ui_version get_threshold_alert get_used_triggers get_workspace_as_super_admin get_workspace_default_app get_workspace_encryption_key get_workspace_name get_workspace_slack_oauth_config get_workspace_usage import_pg_database invite_user is_domain_allowed leave_workspace list_available_teams_channels list_available_teams_ids list_data_table_schemas list_data_table_tables list_data_tables list_datatable_migrations list_deployment_request_eligible_deployers Returns admins and members of wm_deployers in the parent workspace of the fork at {workspace}. list_ducklakes list_pending_invites list_protection_rules list_shared_ui list_user_workspaces list_workspaces list_workspaces_as_super_admin list_ws_specific list_ws_specific_versions log_feature_usage prune_versions rebuild_dependency_map reset_diff_tally This endpoint should be called after a fork deployement rollback_datatable_migrations run_datatable_migrations run_slack_message_test_job run_teams_message_test_job seed_full_diff_scan Enumerates every item of both workspaces as an undecided diff candidate so compareWorkspaces can compare a pair the fork lineage does not track. Requires being an admin of both workspaces, and is rejected for a pair already linked by the lineage (whose diff is tallied continuously). The comparison itself is what compares the candidates, and is the expensive step. set_environment_variable set_threshold_alert set_workspace_encryption_key set_workspace_slack_oauth_config set_ws_specific test_data_table_connection unarchive_workspace update_operator_settings Updates the operator settings for a specific workspace. Requires workspace admin privileges. update_protection_rule update_shared_ui upsert_datatable_migration