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 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 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 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 DropForkedDatatableDatabasesError struct for typed errors of method drop_forked_datatable_databases 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 EditDefaultScriptsError struct for typed errors of method edit_default_scripts EditDeployToError struct for typed errors of method edit_deploy_to 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 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 EditWorkspaceDeployUiSettingsError struct for typed errors of method edit_workspace_deploy_ui_settings EditWorkspaceGitSyncConfigError struct for typed errors of method edit_workspace_git_sync_config 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 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 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 GetGitSyncEnabledError struct for typed errors of method get_git_sync_enabled GetGitSyncPinStatusError struct for typed errors of method get_git_sync_pin_status 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 GetPublicSettingsError struct for typed errors of method get_public_settings GetSettingsError struct for typed errors of method get_settings 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 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 GitSyncInitRepoZipError struct for typed errors of method git_sync_init_repo_zip 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 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 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 LogAiChatError struct for typed errors of method log_ai_chat PruneVersionsError struct for typed errors of method prune_versions RebuildDependencyMapError struct for typed errors of method rebuild_dependency_map RepinGitSyncRepositoryError struct for typed errors of method repin_git_sync_repository ResetDiffTallyError struct for typed errors of method reset_diff_tally RunSlackMessageTestJobError struct for typed errors of method run_slack_message_test_job RunTeamsMessageTestJobError struct for typed errors of method run_teams_message_test_job 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 TarballWorkspaceError struct for typed errors of method tarball_workspace 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 add_user archive_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, resources, and variables. Returns information about items that are ahead, behind, or in conflict. connect_slack connect_teams 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_git_sync_repository delete_invite delete_protection_rule delete_workspace delete_workspace_slack_oauth_config drop_forked_datatable_databases edit_auto_invite edit_copilot_config edit_data_table_config edit_default_scripts edit_deploy_to edit_ducklake_config edit_error_handler edit_git_sync_repository edit_instance_groups edit_large_file_storage_config edit_slack_command edit_success_handler edit_teams_command edit_webhook edit_workspace_deploy_ui_settings edit_workspace_git_sync_config exists_username exists_workspace export_pg_schema get_cloud_quotas get_copilot_info get_copilot_settings_state get_data_table_table_schema get_datatable_full_schema get_default_scripts get_dependency_map get_dependents get_dependents_amounts get_deploy_to get_git_sync_enabled get_git_sync_pin_status get_imports get_is_premium get_open_deployment_request 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_settings Returns the full workspace settings including admin-managed integration credentials. Admin-only — non-admin callers should use getPublicSettings. get_threshold_alert get_used_triggers get_workspace_as_super_admin get_workspace_encryption_key get_workspace_name get_workspace_slack_oauth_config get_workspace_usage git_sync_init_repo_zip #1735. A ZIP holding a new git sync repository: orvanta.yaml (the workspace binding, a base URL placeholder, and sync filters mirroring the workspace’s git sync settings, or the settings UI’s defaults when none are configured), README.md, .gitignore, a .gitkeep in every type directory the filters include that holds no object, and every in-scope object rendered exactly as native git sync writes it (the type-first layout of docs/git-format.md §0). Works for an empty workspace (skeleton only) and a populated one. Secret variables are written with an empty value, and workspace settings and the encryption key are never included. Other objects are exported as stored: a credential kept inline in a connection, a trigger’s configuration or a schedule’s arguments (rather than as a $var: reference) is in the archive. The x-orvanta-export-warnings response header says so whenever those kinds are in scope, names each connection whose password fields hold a literal, and names objects the layout cannot place (left out, as for the export tarball). Workspace admins only; a scoped token needs workspaces:read in addition to the route’s git_sync:read. Every download is audit-logged (git_sync.init_repo_zip). 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_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_user_workspaces list_workspaces list_workspaces_as_super_admin list_ws_specific list_ws_specific_versions log_ai_chat prune_versions rebuild_dependency_map repin_git_sync_repository Succeeds only if the resource still resolves to exactly the expected remote and branch (what the admin was shown). Admin-only; audited. reset_diff_tally This endpoint should be called after a fork deployement run_slack_message_test_job run_teams_message_test_job Queues a hub-script job, exactly like its Slack sibling runSlackMessageTestJob – shared UI (the workspace error/recovery/ success-handler "send test message" button) polls the returned job_uuid the same way for either platform. set_environment_variable set_threshold_alert set_workspace_encryption_key set_workspace_slack_oauth_config tarball_workspace Pre-existing gap closed by #729: this endpoint was never in openapi.yaml even though it long predates BPMN/DMN. flows, scripts, folders and (opt-in) resources/variables are always included; schedules, triggers, users, groups, settings, the encryption key and workspace dependencies are opt-in via their own include_* flag. BPMN flows are exported unconditionally, like flows. DMN decisions are opt-in via include_dmn, unlike BPMN – see that flag’s description. Not entitlement-gated: export is the escape hatch and must keep working regardless of the caller’s licence tier. unarchive_workspace update_operator_settings Updates the operator settings for a specific workspace. Requires workspace admin privileges. update_protection_rule