# \WorkspaceApi
All URIs are relative to */api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**add_user**](WorkspaceApi.md#add_user) | **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)
[**apply_datatable_acl**](WorkspaceApi.md#apply_datatable_acl) | **POST** /w/{workspace}/workspaces/datatable_acl/{datatable_name}/apply | run an ownership or grant change exactly as planned (data table administrators only)
[**archive_workspace**](WorkspaceApi.md#archive_workspace) | **POST** /w/{workspace}/workspaces/archive | archive workspace
[**attach_dev_workspace**](WorkspaceApi.md#attach_dev_workspace) | **POST** /w/{workspace}/workspaces/attach_dev_workspace | attach an existing workspace as the dev workspace of this (prod) workspace
[**cancel_deployment_request**](WorkspaceApi.md#cancel_deployment_request) | **POST** /w/{workspace}/deployment_request/{id}/cancel | cancel an open deployment request
[**change_workspace_color**](WorkspaceApi.md#change_workspace_color) | **POST** /w/{workspace}/workspaces/change_workspace_color | change workspace id
[**change_workspace_id**](WorkspaceApi.md#change_workspace_id) | **POST** /w/{workspace}/workspaces/change_workspace_id | change workspace id
[**change_workspace_name**](WorkspaceApi.md#change_workspace_name) | **POST** /w/{workspace}/workspaces/change_workspace_name | change workspace name
[**close_deployment_request_merged**](WorkspaceApi.md#close_deployment_request_merged) | **POST** /w/{workspace}/deployment_request/{id}/close_merged | close a deployment request after a successful merge
[**compare_workspaces**](WorkspaceApi.md#compare_workspaces) | **GET** /w/{workspace}/workspaces/compare/{target_workspace_id} | Compare two workspaces
[**connect_remote_deploy**](WorkspaceApi.md#connect_remote_deploy) | **POST** /w/{workspace}/remote_deploy/connect | store the caller's own token for the remote deploy target
[**connect_slack**](WorkspaceApi.md#connect_slack) | **POST** /w/{workspace}/workspaces/connect_slack | connect slack (non-interactive; pre-minted bot token)
[**connect_teams**](WorkspaceApi.md#connect_teams) | **POST** /w/{workspace}/workspaces/connect_teams | connect teams
[**create_datatable_migration**](WorkspaceApi.md#create_datatable_migration) | **POST** /w/{workspace}/workspaces/create_datatable_migration/{datatable_name} | create a single datatable migration (version generated server-side)
[**create_deployment_request**](WorkspaceApi.md#create_deployment_request) | **POST** /w/{workspace}/deployment_request | create a new deployment request
[**create_deployment_request_comment**](WorkspaceApi.md#create_deployment_request_comment) | **POST** /w/{workspace}/deployment_request/{id}/comment | append a comment to an open deployment request
[**create_pg_database**](WorkspaceApi.md#create_pg_database) | **POST** /w/{workspace}/workspaces/create_pg_database | create a new PostgreSQL database for a datatable
[**create_protection_rule**](WorkspaceApi.md#create_protection_rule) | **POST** /w/{workspace}/workspaces/protection_rules | create a new protection rule
[**create_service_account**](WorkspaceApi.md#create_service_account) | **POST** /w/{workspace}/workspaces/create_service_account | create a service account
[**create_workspace**](WorkspaceApi.md#create_workspace) | **POST** /workspaces/create | create workspace
[**create_workspace_fork**](WorkspaceApi.md#create_workspace_fork) | **POST** /w/{workspace}/workspaces/create_fork | create forked workspace
[**create_workspace_fork_git_branch**](WorkspaceApi.md#create_workspace_fork_git_branch) | **POST** /w/{workspace}/workspaces/create_workspace_fork_branch | create forked workspace branch with git sync
[**delete_datatable_migration**](WorkspaceApi.md#delete_datatable_migration) | **DELETE** /w/{workspace}/workspaces/delete_datatable_migration/{datatable_name}/{timestamp} | delete a single datatable migration definition
[**delete_git_sync_repository**](WorkspaceApi.md#delete_git_sync_repository) | **DELETE** /w/{workspace}/workspaces/delete_git_sync_repository | delete individual git sync repository
[**delete_invite**](WorkspaceApi.md#delete_invite) | **POST** /w/{workspace}/workspaces/delete_invite | delete user invite
[**delete_protection_rule**](WorkspaceApi.md#delete_protection_rule) | **DELETE** /w/{workspace}/workspaces/protection_rules/{rule_name} | delete a protection rule
[**delete_workspace**](WorkspaceApi.md#delete_workspace) | **DELETE** /workspaces/delete/{workspace} | delete workspace (require super admin)
[**delete_workspace_slack_oauth_config**](WorkspaceApi.md#delete_workspace_slack_oauth_config) | **DELETE** /w/{workspace}/workspaces/slack_oauth_config | delete workspace slack oauth config
[**detach_dev_workspace**](WorkspaceApi.md#detach_dev_workspace) | **POST** /w/{workspace}/workspaces/detach_dev_workspace | detach the dev workspace from this (prod) workspace
[**disable_datatable_migrations**](WorkspaceApi.md#disable_datatable_migrations) | **POST** /w/{workspace}/workspaces/disable_datatable_migrations/{datatable_name} | opt a datatable out of migrations, deleting all of them (admins / super admins only)
[**disconnect_remote_deploy**](WorkspaceApi.md#disconnect_remote_deploy) | **POST** /w/{workspace}/remote_deploy/disconnect | forget the caller's token for the remote deploy target
[**drop_forked_datatable_databases**](WorkspaceApi.md#drop_forked_datatable_databases) | **POST** /w/{workspace}/workspaces/drop_forked_datatable_databases | drop forked datatable databases
[**drop_forked_ducklake_namespaces**](WorkspaceApi.md#drop_forked_ducklake_namespaces) | **POST** /w/{workspace}/workspaces/drop_forked_ducklake_namespaces | drop this fork workspace's ducklake namespaces (catalog metadata schemas + data files)
[**edit_add_admins_and_developers_to_forks**](WorkspaceApi.md#edit_add_admins_and_developers_to_forks) | **POST** /w/{workspace}/workspaces/edit_add_admins_and_developers_to_forks | choose whether new forks of this workspace start with its admins and developers
[**edit_auto_invite**](WorkspaceApi.md#edit_auto_invite) | **POST** /w/{workspace}/workspaces/edit_auto_invite | edit auto invite
[**edit_copilot_config**](WorkspaceApi.md#edit_copilot_config) | **POST** /w/{workspace}/workspaces/edit_copilot_config | edit copilot config
[**edit_data_table_config**](WorkspaceApi.md#edit_data_table_config) | **POST** /w/{workspace}/workspaces/edit_datatable_config | edit datatable settings
[**edit_dbt_warehouses**](WorkspaceApi.md#edit_dbt_warehouses) | **POST** /w/{workspace}/workspaces/edit_dbt_warehouses | edit the workspace's dbt warehouses
[**edit_default_scripts**](WorkspaceApi.md#edit_default_scripts) | **POST** /w/{workspace}/workspaces/default_scripts | edit default scripts for workspace
[**edit_ducklake_config**](WorkspaceApi.md#edit_ducklake_config) | **POST** /w/{workspace}/workspaces/edit_ducklake_config | edit ducklake settings
[**edit_error_handler**](WorkspaceApi.md#edit_error_handler) | **POST** /w/{workspace}/workspaces/edit_error_handler | edit error handler
[**edit_git_sync_repository**](WorkspaceApi.md#edit_git_sync_repository) | **POST** /w/{workspace}/workspaces/edit_git_sync_repository | add or update individual git sync repository
[**edit_guest_access**](WorkspaceApi.md#edit_guest_access) | **POST** /w/{workspace}/workspaces/edit_guest_access | enable or disable guest sessions for this workspace
[**edit_guest_jwt_key**](WorkspaceApi.md#edit_guest_jwt_key) | **POST** /w/{workspace}/workspaces/edit_guest_jwt_key | set the key guest JWTs are verified against for this workspace
[**edit_instance_groups**](WorkspaceApi.md#edit_instance_groups) | **POST** /w/{workspace}/workspaces/edit_instance_groups | edit instance groups
[**edit_large_file_storage_config**](WorkspaceApi.md#edit_large_file_storage_config) | **POST** /w/{workspace}/workspaces/edit_large_file_storage_config | edit large file storage settings
[**edit_slack_command**](WorkspaceApi.md#edit_slack_command) | **POST** /w/{workspace}/workspaces/edit_slack_command | edit slack command
[**edit_success_handler**](WorkspaceApi.md#edit_success_handler) | **POST** /w/{workspace}/workspaces/edit_success_handler | edit success handler
[**edit_teams_command**](WorkspaceApi.md#edit_teams_command) | **POST** /w/{workspace}/workspaces/edit_teams_command | edit teams command
[**edit_webhook**](WorkspaceApi.md#edit_webhook) | **POST** /w/{workspace}/workspaces/edit_webhook | edit webhook
[**edit_workspace_default_app**](WorkspaceApi.md#edit_workspace_default_app) | **POST** /w/{workspace}/workspaces/edit_default_app | edit default app for workspace
[**edit_workspace_deploy_ui_settings**](WorkspaceApi.md#edit_workspace_deploy_ui_settings) | **POST** /w/{workspace}/workspaces/edit_deploy_ui_config | edit workspace deploy ui settings
[**edit_workspace_git_sync_config**](WorkspaceApi.md#edit_workspace_git_sync_config) | **POST** /w/{workspace}/workspaces/edit_git_sync_config | edit workspace git sync settings
[**enable_datatable_migrations**](WorkspaceApi.md#enable_datatable_migrations) | **POST** /w/{workspace}/workspaces/enable_datatable_migrations/{datatable_name} | opt a datatable in to migrations (admins / super admins only)
[**exists_username**](WorkspaceApi.md#exists_username) | **POST** /workspaces/exists_username | exists username
[**exists_workspace**](WorkspaceApi.md#exists_workspace) | **POST** /workspaces/exists | exists workspace
[**export_pg_schema**](WorkspaceApi.md#export_pg_schema) | **POST** /w/{workspace}/workspaces/export_pg_schema | export the schema of a PostgreSQL database
[**generate_initial_datatable_migration**](WorkspaceApi.md#generate_initial_datatable_migration) | **POST** /w/{workspace}/workspaces/generate_initial_datatable_migration/{datatable_name} | snapshot the current schema as an already-installed initial migration
[**get_billable_seats**](WorkspaceApi.md#get_billable_seats) | **GET** /w/{workspace}/workspaces/billable_seats | get the billable seats of the workspace the plan is billed on
[**get_cloud_quotas**](WorkspaceApi.md#get_cloud_quotas) | **GET** /w/{workspace}/workspaces/cloud_quotas | get cloud quota usage and limits for workspace
[**get_copilot_info**](WorkspaceApi.md#get_copilot_info) | **GET** /w/{workspace}/workspaces/get_copilot_info | get copilot info
[**get_copilot_settings_state**](WorkspaceApi.md#get_copilot_settings_state) | **GET** /w/{workspace}/workspaces/get_copilot_settings_state | get copilot settings state
[**get_data_table_table_schema**](WorkspaceApi.md#get_data_table_table_schema) | **GET** /w/{workspace}/workspaces/get_datatable_table_schema | get one Datatable table schema
[**get_datatable_acl**](WorkspaceApi.md#get_datatable_acl) | **GET** /w/{workspace}/workspaces/datatable_acl/{datatable_name} | read the owner and grants of an instance data table's database, schema or table
[**get_datatable_full_schema**](WorkspaceApi.md#get_datatable_full_schema) | **POST** /w/{workspace}/workspaces/get_datatable_full_schema | get the full schema of a datatable database as TableEditorValues
[**get_datatable_migrations_status**](WorkspaceApi.md#get_datatable_migrations_status) | **GET** /w/{workspace}/workspaces/datatable_migrations_status/{datatable_name} | list a datatable's migrations with their applied status
[**get_datatable_permissions**](WorkspaceApi.md#get_datatable_permissions) | **GET** /w/{workspace}/workspaces/datatable_permissions/{datatable_name} | get who may connect to a data table as which role
[**get_default_scripts**](WorkspaceApi.md#get_default_scripts) | **GET** /w/{workspace}/workspaces/default_scripts | get default scripts for workspace
[**get_dependency_map**](WorkspaceApi.md#get_dependency_map) | **GET** /w/{workspace}/workspaces/get_dependency_map | get dependency map
[**get_dependents**](WorkspaceApi.md#get_dependents) | **GET** /w/{workspace}/workspaces/get_dependents/{imported_path} | get dependents of an imported path
[**get_dependents_amounts**](WorkspaceApi.md#get_dependents_amounts) | **POST** /w/{workspace}/workspaces/get_dependents_amounts | get dependents amounts for multiple imported paths
[**get_deploy_to**](WorkspaceApi.md#get_deploy_to) | **GET** /w/{workspace}/workspaces/get_deploy_to | get the workspace this one deploys into (its fork parent)
[**get_dev_workspace**](WorkspaceApi.md#get_dev_workspace) | **GET** /w/{workspace}/workspaces/get_dev_workspace | this workspace's active canonical dev workspace, if any
[**get_git_sync_deploy_mode**](WorkspaceApi.md#get_git_sync_deploy_mode) | **GET** /w/{workspace}/workspaces/git_sync_deploy_mode | Get how local changes deploy to this workspace via git sync
[**get_git_sync_enabled**](WorkspaceApi.md#get_git_sync_enabled) | **GET** /w/{workspace}/workspaces/git_sync_enabled | Check if git sync is available for this workspace
[**get_github_app_repo_archive**](WorkspaceApi.md#get_github_app_repo_archive) | **GET** /w/{workspace}/github_app/repo_archive/{path} | download a gzipped tarball of a GitHub App repository
[**get_github_app_token**](WorkspaceApi.md#get_github_app_token) | **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_guest_usage**](WorkspaceApi.md#get_guest_usage) | **GET** /w/{workspace}/workspaces/guest_usage | the instance's standing against the guest allowance
[**get_imports**](WorkspaceApi.md#get_imports) | **GET** /w/{workspace}/workspaces/get_imports/{importer_path} | get script imports for an importer path
[**get_is_premium**](WorkspaceApi.md#get_is_premium) | **GET** /w/{workspace}/workspaces/is_premium | get if workspace is premium
[**get_open_deployment_request**](WorkspaceApi.md#get_open_deployment_request) | **GET** /w/{workspace}/deployment_request/open | get the currently open deployment request for this fork
[**get_premium_info**](WorkspaceApi.md#get_premium_info) | **GET** /w/{workspace}/workspaces/premium_info | get premium info
[**get_public_settings**](WorkspaceApi.md#get_public_settings) | **GET** /w/{workspace}/workspaces/get_public_settings | get public settings
[**get_remote_deploy_target**](WorkspaceApi.md#get_remote_deploy_target) | **GET** /w/{workspace}/remote_deploy/target | get the workspace's deploy target on another instance, and the caller's connection to it
[**get_session_workspace_retention**](WorkspaceApi.md#get_session_workspace_retention) | **POST** /workspaces/session_workspace_retention | get the AI session retention of workspaces referenced by client-side sessions
[**get_session_workspace_status**](WorkspaceApi.md#get_session_workspace_status) | **POST** /workspaces/session_workspace_status | get the lifecycle status of workspaces referenced by client-side sessions
[**get_settings**](WorkspaceApi.md#get_settings) | **GET** /w/{workspace}/workspaces/get_settings | get settings (admin only)
[**get_shared_ui**](WorkspaceApi.md#get_shared_ui) | **GET** /w/{workspace}/shared_ui/get | get the workspace shared UI folder (full content)
[**get_shared_ui_version**](WorkspaceApi.md#get_shared_ui_version) | **GET** /w/{workspace}/shared_ui/version | get the current version of the workspace shared UI folder
[**get_threshold_alert**](WorkspaceApi.md#get_threshold_alert) | **GET** /w/{workspace}/workspaces/threshold_alert | get threshold alert info
[**get_used_triggers**](WorkspaceApi.md#get_used_triggers) | **GET** /w/{workspace}/workspaces/used_triggers | get used triggers
[**get_workspace_as_super_admin**](WorkspaceApi.md#get_workspace_as_super_admin) | **GET** /w/{workspace}/workspaces/get_as_superadmin | get workspace as super admin (require to be super admin)
[**get_workspace_default_app**](WorkspaceApi.md#get_workspace_default_app) | **GET** /w/{workspace}/workspaces/default_app | get default app for workspace
[**get_workspace_encryption_key**](WorkspaceApi.md#get_workspace_encryption_key) | **GET** /w/{workspace}/workspaces/encryption_key | retrieves the encryption key for this workspace
[**get_workspace_name**](WorkspaceApi.md#get_workspace_name) | **GET** /w/{workspace}/workspaces/get_workspace_name | get workspace name
[**get_workspace_slack_oauth_config**](WorkspaceApi.md#get_workspace_slack_oauth_config) | **GET** /w/{workspace}/workspaces/slack_oauth_config | get workspace slack oauth config
[**get_workspace_usage**](WorkspaceApi.md#get_workspace_usage) | **GET** /w/{workspace}/workspaces/usage | get usage
[**import_pg_database**](WorkspaceApi.md#import_pg_database) | **POST** /w/{workspace}/workspaces/import_pg_database | import a PostgreSQL database from source to target via pg_dump
[**invite_user**](WorkspaceApi.md#invite_user) | **POST** /w/{workspace}/workspaces/invite_user | invite user to workspace
[**is_domain_allowed**](WorkspaceApi.md#is_domain_allowed) | **GET** /workspaces/allowed_domain_auto_invite | is domain allowed for auto invi
[**leave_workspace**](WorkspaceApi.md#leave_workspace) | **POST** /w/{workspace}/workspaces/leave | leave workspace
[**list_available_teams_channels**](WorkspaceApi.md#list_available_teams_channels) | **GET** /w/{workspace}/workspaces/available_teams_channels | list available channels for a specific team
[**list_available_teams_ids**](WorkspaceApi.md#list_available_teams_ids) | **GET** /w/{workspace}/workspaces/available_teams_ids | list available teams ids
[**list_data_table_schemas**](WorkspaceApi.md#list_data_table_schemas) | **GET** /w/{workspace}/workspaces/list_datatable_schemas | list schemas of all connected Datatables
[**list_data_table_tables**](WorkspaceApi.md#list_data_table_tables) | **GET** /w/{workspace}/workspaces/list_datatable_tables | list tables of all connected Datatables
[**list_data_tables**](WorkspaceApi.md#list_data_tables) | **GET** /w/{workspace}/workspaces/list_datatables | list Datatables
[**list_datatable_migrations**](WorkspaceApi.md#list_datatable_migrations) | **GET** /w/{workspace}/workspaces/list_datatable_migrations | list datatable migrations for a workspace
[**list_deployment_request_eligible_deployers**](WorkspaceApi.md#list_deployment_request_eligible_deployers) | **GET** /w/{workspace}/deployment_request/eligible_deployers | list users eligible to be deployment request assignees
[**list_ducklakes**](WorkspaceApi.md#list_ducklakes) | **GET** /w/{workspace}/workspaces/list_ducklakes | list ducklakes
[**list_pending_invites**](WorkspaceApi.md#list_pending_invites) | **GET** /w/{workspace}/workspaces/list_pending_invites | list pending invites for a workspace
[**list_protection_rules**](WorkspaceApi.md#list_protection_rules) | **GET** /w/{workspace}/workspaces/protection_rules | list all protection rules for a workspace
[**list_shared_ui**](WorkspaceApi.md#list_shared_ui) | **GET** /w/{workspace}/shared_ui/list | list paths/sizes of the workspace shared UI folder
[**list_usable_datatable_roles**](WorkspaceApi.md#list_usable_datatable_roles) | **GET** /w/{workspace}/workspaces/datatable_usable_roles/{datatable_name} | list the data table roles the caller may connect as
[**list_user_workspaces**](WorkspaceApi.md#list_user_workspaces) | **GET** /workspaces/users | list all workspaces visible to me with user info
[**list_workspaces**](WorkspaceApi.md#list_workspaces) | **GET** /workspaces/list | list all workspaces visible to me
[**list_workspaces_as_super_admin**](WorkspaceApi.md#list_workspaces_as_super_admin) | **GET** /workspaces/list_as_superadmin | list all workspaces as super admin (require to be super admin)
[**list_ws_specific**](WorkspaceApi.md#list_ws_specific) | **GET** /w/{workspace}/workspaces/list_ws_specific | list all workspace-specific items
[**list_ws_specific_versions**](WorkspaceApi.md#list_ws_specific_versions) | **GET** /w/{workspace}/workspaces/list_ws_specific_versions | list workspace ids that have a version of the given item
[**log_feature_usage**](WorkspaceApi.md#log_feature_usage) | **POST** /w/{workspace}/workspaces/log_feature_usage | log anonymous feature usage telemetry events
[**plan_datatable_acl**](WorkspaceApi.md#plan_datatable_acl) | **POST** /w/{workspace}/workspaces/datatable_acl/{datatable_name}/plan | preview the SQL an ownership or grant change would run (data table administrators only)
[**prune_versions**](WorkspaceApi.md#prune_versions) | **POST** /w/{workspace}/workspaces/prune_versions | prune old versions of scripts, flows, apps, or resources
[**rebuild_dependency_map**](WorkspaceApi.md#rebuild_dependency_map) | **POST** /w/{workspace}/workspaces/rebuild_dependency_map | rebuild dependency map
[**reset_diff_tally**](WorkspaceApi.md#reset_diff_tally) | **POST** /w/{workspace}/workspaces/reset_diff_tally/{fork_workspace_id} | Resets the ahead and behind deployement counter after a deployement
[**rollback_datatable_migrations**](WorkspaceApi.md#rollback_datatable_migrations) | **POST** /w/{workspace}/workspaces/rollback_datatable_migrations/{datatable_name} | roll back the most recently applied migration on a datatable
[**run_datatable_migrations**](WorkspaceApi.md#run_datatable_migrations) | **POST** /w/{workspace}/workspaces/run_datatable_migrations/{datatable_name} | run pending datatable migrations against a datatable
[**run_slack_message_test_job**](WorkspaceApi.md#run_slack_message_test_job) | **POST** /w/{workspace}/workspaces/run_slack_message_test_job | run a job that sends a message to Slack
[**run_teams_message_test_job**](WorkspaceApi.md#run_teams_message_test_job) | **POST** /w/{workspace}/workspaces/run_teams_message_test_job | run a job that sends a message to Teams
[**seed_full_diff_scan**](WorkspaceApi.md#seed_full_diff_scan) | **POST** /w/{workspace}/workspaces/seed_full_diff/{target_workspace_id} | Seed the diff candidate set against an arbitrary workspace
[**set_datatable_permissions**](WorkspaceApi.md#set_datatable_permissions) | **POST** /w/{workspace}/workspaces/datatable_permissions/{datatable_name} | set who may connect to a data table as which role
[**set_environment_variable**](WorkspaceApi.md#set_environment_variable) | **POST** /w/{workspace}/workspaces/set_environment_variable | set environment variable
[**set_remote_deploy_target**](WorkspaceApi.md#set_remote_deploy_target) | **POST** /w/{workspace}/remote_deploy/target | set or clear the workspace's deploy target on another instance
[**set_threshold_alert**](WorkspaceApi.md#set_threshold_alert) | **POST** /w/{workspace}/workspaces/threshold_alert | set threshold alert info
[**set_workspace_encryption_key**](WorkspaceApi.md#set_workspace_encryption_key) | **POST** /w/{workspace}/workspaces/encryption_key | update the encryption key for this workspace
[**set_workspace_slack_oauth_config**](WorkspaceApi.md#set_workspace_slack_oauth_config) | **POST** /w/{workspace}/workspaces/slack_oauth_config | set workspace slack oauth config
[**set_ws_specific**](WorkspaceApi.md#set_ws_specific) | **POST** /w/{workspace}/workspaces/set_ws_specific | mark or unmark an item as workspace-specific
[**test_data_table_connection**](WorkspaceApi.md#test_data_table_connection) | **GET** /w/{workspace}/workspaces/test_datatable_connection/{datatable_name} | check what the data table's database lets its role do
[**unarchive_workspace**](WorkspaceApi.md#unarchive_workspace) | **POST** /workspaces/unarchive/{workspace} | unarchive workspace
[**update_operator_settings**](WorkspaceApi.md#update_operator_settings) | **POST** /w/{workspace}/workspaces/operator_settings | Update operator settings for a workspace
[**update_protection_rule**](WorkspaceApi.md#update_protection_rule) | **POST** /w/{workspace}/workspaces/protection_rules/{rule_name} | update an existing protection rule
[**update_shared_ui**](WorkspaceApi.md#update_shared_ui) | **PUT** /w/{workspace}/shared_ui | replace the workspace shared UI folder (admin only)
[**upsert_datatable_migration**](WorkspaceApi.md#upsert_datatable_migration) | **POST** /w/{workspace}/workspaces/upsert_datatable_migration/{datatable_name} | insert or update a single datatable migration at an explicit version
## add_user
> String add_user(workspace, add_user_request)
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)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**add_user_request** | [**AddUserRequest**](AddUserRequest.md) | WorkspaceInvite | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## apply_datatable_acl
> String apply_datatable_acl(workspace, datatable_name, acl_change_request)
run an ownership or grant change exactly as planned (data table administrators only)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | **String** | | [required] |
**acl_change_request** | [**AclChangeRequest**](AclChangeRequest.md) | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## archive_workspace
> String archive_workspace(workspace)
archive workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## attach_dev_workspace
> String attach_dev_workspace(workspace, attach_dev_workspace_request)
attach an existing workspace as the dev workspace of this (prod) workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**attach_dev_workspace_request** | [**AttachDevWorkspaceRequest**](AttachDevWorkspaceRequest.md) | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## cancel_deployment_request
> String cancel_deployment_request(workspace, id)
cancel an open deployment request
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**id** | **i64** | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## change_workspace_color
> String change_workspace_color(workspace, change_workspace_color_request)
change workspace id
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**change_workspace_color_request** | Option<[**ChangeWorkspaceColorRequest**](ChangeWorkspaceColorRequest.md)> | | |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## change_workspace_id
> String change_workspace_id(workspace, change_workspace_id_request)
change workspace id
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**change_workspace_id_request** | Option<[**ChangeWorkspaceIdRequest**](ChangeWorkspaceIdRequest.md)> | | |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## change_workspace_name
> String change_workspace_name(workspace, change_workspace_name_request)
change workspace name
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**change_workspace_name_request** | Option<[**ChangeWorkspaceNameRequest**](ChangeWorkspaceNameRequest.md)> | | |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## close_deployment_request_merged
> String close_deployment_request_merged(workspace, id)
close a deployment request after a successful merge
Called by the UI after the deploy loop completes. Closes the request and marks every comment obsolete. Idempotent.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**id** | **i64** | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## compare_workspaces
> models::WorkspaceComparison compare_workspaces(workspace, target_workspace_id)
Compare two 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.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**target_workspace_id** | **String** | The ID of the workspace to compare with | [required] |
### Return type
[**models::WorkspaceComparison**](WorkspaceComparison.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## connect_remote_deploy
> models::RemoteDeployConnection connect_remote_deploy(workspace, connect_remote_deploy_request)
store the caller's own token for the remote deploy target
The token is checked against the target's whoami before it is stored. `target` names the target the token was obtained for, and the request is refused if the workspace now points elsewhere, so a token is never sent to an instance it was not meant for.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**connect_remote_deploy_request** | [**ConnectRemoteDeployRequest**](ConnectRemoteDeployRequest.md) | | [required] |
### Return type
[**models::RemoteDeployConnection**](RemoteDeployConnection.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## connect_slack
> connect_slack(workspace, connect_slack_request)
connect slack (non-interactive; pre-minted bot token)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**connect_slack_request** | [**ConnectSlackRequest**](ConnectSlackRequest.md) | connect slack with a pre-minted bot token | [required] |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## connect_teams
> String connect_teams(workspace, connect_teams_request)
connect teams
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**connect_teams_request** | [**ConnectTeamsRequest**](ConnectTeamsRequest.md) | connect teams | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## create_datatable_migration
> models::DatatableMigration create_datatable_migration(workspace, datatable_name, create_datatable_migration_request)
create a single datatable migration (version generated server-side)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | **String** | | [required] |
**create_datatable_migration_request** | [**CreateDatatableMigrationRequest**](CreateDatatableMigrationRequest.md) | | [required] |
### Return type
[**models::DatatableMigration**](DatatableMigration.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## create_deployment_request
> models::DeploymentRequest create_deployment_request(workspace, create_deployment_request_request)
create a new deployment request
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**create_deployment_request_request** | [**CreateDeploymentRequestRequest**](CreateDeploymentRequestRequest.md) | | [required] |
### Return type
[**models::DeploymentRequest**](DeploymentRequest.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## create_deployment_request_comment
> models::DeploymentRequestComment create_deployment_request_comment(workspace, id, create_deployment_request_comment_request)
append a comment to an open deployment request
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**id** | **i64** | | [required] |
**create_deployment_request_comment_request** | [**CreateDeploymentRequestCommentRequest**](CreateDeploymentRequestCommentRequest.md) | | [required] |
### Return type
[**models::DeploymentRequestComment**](DeploymentRequestComment.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## create_pg_database
> String create_pg_database(workspace, create_pg_database_request)
create a new PostgreSQL database for a datatable
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**create_pg_database_request** | [**CreatePgDatabaseRequest**](CreatePgDatabaseRequest.md) | Create pg database request | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## create_protection_rule
> String create_protection_rule(workspace, create_protection_rule_request)
create a new protection rule
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**create_protection_rule_request** | [**CreateProtectionRuleRequest**](CreateProtectionRuleRequest.md) | New protection rule configuration | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## create_service_account
> String create_service_account(workspace, create_service_account_request)
create a service account
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**create_service_account_request** | [**CreateServiceAccountRequest**](CreateServiceAccountRequest.md) | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## create_workspace
> String create_workspace(create_workspace)
create workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_workspace** | [**CreateWorkspace**](CreateWorkspace.md) | new token | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## create_workspace_fork
> String create_workspace_fork(workspace, create_workspace_fork)
create forked workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**create_workspace_fork** | [**CreateWorkspaceFork**](CreateWorkspaceFork.md) | new forked workspace | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## create_workspace_fork_git_branch
> Vec<uuid::Uuid> create_workspace_fork_git_branch(workspace, create_workspace_fork)
create forked workspace branch with git sync
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**create_workspace_fork** | [**CreateWorkspaceFork**](CreateWorkspaceFork.md) | new forked workspace | [required] |
### Return type
[**Vec<uuid::Uuid>**](uuid::Uuid.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## delete_datatable_migration
> String delete_datatable_migration(workspace, datatable_name, timestamp)
delete a single datatable migration definition
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | **String** | | [required] |
**timestamp** | **i64** | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## delete_git_sync_repository
> serde_json::Value delete_git_sync_repository(workspace, delete_git_sync_repository_request)
delete individual git sync repository
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**delete_git_sync_repository_request** | [**DeleteGitSyncRepositoryRequest**](DeleteGitSyncRepositoryRequest.md) | Git sync repository to delete | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## delete_invite
> String delete_invite(workspace, delete_invite_request)
delete user invite
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**delete_invite_request** | [**DeleteInviteRequest**](DeleteInviteRequest.md) | WorkspaceInvite | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## delete_protection_rule
> String delete_protection_rule(workspace, rule_name)
delete a protection rule
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**rule_name** | **String** | Name of the protection rule to delete | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## delete_workspace
> String delete_workspace(workspace, only_delete_forks)
delete workspace (require super admin)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**only_delete_forks** | Option<**bool**> | | |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## delete_workspace_slack_oauth_config
> String delete_workspace_slack_oauth_config(workspace)
delete workspace slack oauth config
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## detach_dev_workspace
> String detach_dev_workspace(workspace, detach_dev_workspace_request)
detach the dev workspace from this (prod) workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**detach_dev_workspace_request** | [**DetachDevWorkspaceRequest**](DetachDevWorkspaceRequest.md) | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## disable_datatable_migrations
> String disable_datatable_migrations(workspace, datatable_name)
opt a datatable out of migrations, deleting all of them (admins / super admins only)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | **String** | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## disconnect_remote_deploy
> String disconnect_remote_deploy(workspace)
forget the caller's token for the remote deploy target
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## drop_forked_datatable_databases
> Vec<String> drop_forked_datatable_databases(workspace, drop_forked_datatable_databases_request)
drop forked datatable databases
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**drop_forked_datatable_databases_request** | [**DropForkedDatatableDatabasesRequest**](DropForkedDatatableDatabasesRequest.md) | | [required] |
### Return type
**Vec<String>**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## drop_forked_ducklake_namespaces
> Vec<String> drop_forked_ducklake_namespaces(workspace)
drop this fork workspace's ducklake namespaces (catalog metadata schemas + data files)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
**Vec<String>**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_add_admins_and_developers_to_forks
> String edit_add_admins_and_developers_to_forks(workspace, edit_add_admins_and_developers_to_forks_request)
choose whether new forks of this workspace start with its admins and developers
When on, every fork created from this workspace gets the workspace's admins and developers as members, with the role they hold here; operators, disabled users and service accounts are left out. The setting is copied into each fork, so forks of a fork follow it too. Off by default. Workspace-admin gated.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_add_admins_and_developers_to_forks_request** | [**EditAddAdminsAndDevelopersToForksRequest**](EditAddAdminsAndDevelopersToForksRequest.md) | Whether new forks start with this workspace's admins and developers | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_auto_invite
> String edit_auto_invite(workspace, edit_auto_invite_request)
edit auto invite
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_auto_invite_request** | [**EditAutoInviteRequest**](EditAutoInviteRequest.md) | WorkspaceInvite | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_copilot_config
> models::EditCopilotConfig200Response edit_copilot_config(workspace, ai_config)
edit copilot config
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**ai_config** | [**AiConfig**](AiConfig.md) | WorkspaceCopilotConfig | [required] |
### Return type
[**models::EditCopilotConfig200Response**](editCopilotConfig_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_data_table_config
> models::EditDataTableConfig200Response edit_data_table_config(workspace, edit_data_table_config_request)
edit datatable settings
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_data_table_config_request** | [**EditDataTableConfigRequest**](EditDataTableConfigRequest.md) | DataTable settings | [required] |
### Return type
[**models::EditDataTableConfig200Response**](editDataTableConfig_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_dbt_warehouses
> serde_json::Value edit_dbt_warehouses(workspace, edit_dbt_warehouses_request)
edit the workspace's dbt warehouses
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_dbt_warehouses_request** | [**EditDbtWarehousesRequest**](EditDbtWarehousesRequest.md) | dbt warehouses, by name | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_default_scripts
> String edit_default_scripts(workspace, workspace_default_scripts)
edit default scripts for workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**workspace_default_scripts** | Option<[**WorkspaceDefaultScripts**](WorkspaceDefaultScripts.md)> | Workspace default app | |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_ducklake_config
> serde_json::Value edit_ducklake_config(workspace, edit_ducklake_config_request)
edit ducklake settings
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_ducklake_config_request** | [**EditDucklakeConfigRequest**](EditDucklakeConfigRequest.md) | Ducklake settings | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_error_handler
> String edit_error_handler(workspace, edit_error_handler)
edit error handler
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_error_handler** | [**EditErrorHandler**](EditErrorHandler.md) | WorkspaceErrorHandler | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_git_sync_repository
> serde_json::Value edit_git_sync_repository(workspace, edit_git_sync_repository_request)
add or update individual git sync repository
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_git_sync_repository_request** | [**EditGitSyncRepositoryRequest**](EditGitSyncRepositoryRequest.md) | Git sync repository settings to add or update | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_guest_access
> String edit_guest_access(workspace, edit_guest_access_request)
enable or disable guest sessions for this workspace
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`. Turning it *on* is refused with a 400 where guests are unavailable (the shared cloud); turning it off always works.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_guest_access_request** | [**EditGuestAccessRequest**](EditGuestAccessRequest.md) | Whether guest sessions are admitted | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_guest_jwt_key
> String edit_guest_jwt_key(workspace, edit_guest_jwt_key_request)
set the key guest JWTs are verified against for this workspace
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. Setting a key is refused with a 400 where guests are unavailable (the shared cloud); clearing one always works.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_guest_jwt_key_request** | [**EditGuestJwtKeyRequest**](EditGuestJwtKeyRequest.md) | The guest JWT verification key | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_instance_groups
> String edit_instance_groups(workspace, edit_instance_groups_request)
edit instance groups
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_instance_groups_request** | [**EditInstanceGroupsRequest**](EditInstanceGroupsRequest.md) | Instance Groups Configuration | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_large_file_storage_config
> serde_json::Value edit_large_file_storage_config(workspace, edit_large_file_storage_config_request)
edit large file storage settings
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_large_file_storage_config_request** | [**EditLargeFileStorageConfigRequest**](EditLargeFileStorageConfigRequest.md) | LargeFileStorage info | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_slack_command
> String edit_slack_command(workspace, edit_slack_command_request)
edit slack command
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_slack_command_request** | [**EditSlackCommandRequest**](EditSlackCommandRequest.md) | WorkspaceInvite | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_success_handler
> String edit_success_handler(workspace, edit_success_handler)
edit success handler
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_success_handler** | [**EditSuccessHandler**](EditSuccessHandler.md) | WorkspaceSuccessHandler | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_teams_command
> String edit_teams_command(workspace, edit_slack_command_request)
edit teams command
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_slack_command_request** | [**EditSlackCommandRequest**](EditSlackCommandRequest.md) | WorkspaceInvite | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_webhook
> String edit_webhook(workspace, edit_webhook_request)
edit webhook
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_webhook_request** | [**EditWebhookRequest**](EditWebhookRequest.md) | WorkspaceWebhook | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_workspace_default_app
> String edit_workspace_default_app(workspace, edit_workspace_default_app_request)
edit default app for workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_workspace_default_app_request** | [**EditWorkspaceDefaultAppRequest**](EditWorkspaceDefaultAppRequest.md) | Workspace default app | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_workspace_deploy_ui_settings
> serde_json::Value edit_workspace_deploy_ui_settings(workspace, edit_workspace_deploy_ui_settings_request)
edit workspace deploy ui settings
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_workspace_deploy_ui_settings_request** | [**EditWorkspaceDeployUiSettingsRequest**](EditWorkspaceDeployUiSettingsRequest.md) | Workspace deploy UI settings | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## edit_workspace_git_sync_config
> serde_json::Value edit_workspace_git_sync_config(workspace, edit_workspace_git_sync_config_request)
edit workspace git sync settings
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**edit_workspace_git_sync_config_request** | [**EditWorkspaceGitSyncConfigRequest**](EditWorkspaceGitSyncConfigRequest.md) | Workspace Git sync settings | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## enable_datatable_migrations
> String enable_datatable_migrations(workspace, datatable_name)
opt a datatable in to migrations (admins / super admins only)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | **String** | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## exists_username
> bool exists_username(exists_username_request)
exists username
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**exists_username_request** | [**ExistsUsernameRequest**](ExistsUsernameRequest.md) | | [required] |
### Return type
**bool**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## exists_workspace
> bool exists_workspace(exists_workspace_request)
exists workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**exists_workspace_request** | [**ExistsWorkspaceRequest**](ExistsWorkspaceRequest.md) | id of workspace | [required] |
### Return type
**bool**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## export_pg_schema
> String export_pg_schema(workspace, export_pg_schema_request)
export the schema of a PostgreSQL database
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**export_pg_schema_request** | [**ExportPgSchemaRequest**](ExportPgSchemaRequest.md) | Export pg schema request | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## generate_initial_datatable_migration
> models::DatatableMigration generate_initial_datatable_migration(workspace, datatable_name)
snapshot the current schema as an already-installed initial migration
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | **String** | | [required] |
### Return type
[**models::DatatableMigration**](DatatableMigration.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_billable_seats
> models::GetBillableSeats200Response get_billable_seats(workspace)
get the billable seats of the workspace the plan is billed on
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::GetBillableSeats200Response**](getBillableSeats_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_cloud_quotas
> models::GetCloudQuotas200Response get_cloud_quotas(workspace)
get cloud quota usage and limits for workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::GetCloudQuotas200Response**](getCloudQuotas_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_copilot_info
> models::AiConfig get_copilot_info(workspace)
get copilot info
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::AiConfig**](AIConfig.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_copilot_settings_state
> models::GetCopilotSettingsState200Response get_copilot_settings_state(workspace)
get copilot settings state
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::GetCopilotSettingsState200Response**](getCopilotSettingsState_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_data_table_table_schema
> models::DataTableTableSchema get_data_table_table_schema(workspace, datatable_name, schema_name, table_name, role)
get one Datatable table schema
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | **String** | | [required] |
**schema_name** | **String** | | [required] |
**table_name** | **String** | | [required] |
**role** | Option<**String**> | the data table role to read the table as; defaults to the data table's default role | |
### Return type
[**models::DataTableTableSchema**](DataTableTableSchema.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_datatable_acl
> models::DatatableAclInfo get_datatable_acl(workspace, datatable_name, kind, schema, table)
read the owner and grants of an instance data table's database, schema or table
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | **String** | | [required] |
**kind** | **String** | | [required] |
**schema** | Option<**String**> | | |
**table** | Option<**String**> | | |
### Return type
[**models::DatatableAclInfo**](DatatableAclInfo.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_datatable_full_schema
> std::collections::HashMap<String, std::collections::HashMap<String, models::GetDatatableFullSchema200ResponseValueValue>> get_datatable_full_schema(workspace, get_datatable_full_schema_request)
get the full schema of a datatable database as TableEditorValues
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**get_datatable_full_schema_request** | [**GetDatatableFullSchemaRequest**](GetDatatableFullSchemaRequest.md) | | [required] |
### Return type
[**std::collections::HashMap<String, std::collections::HashMap<String, models::GetDatatableFullSchema200ResponseValueValue>>**](std::collections::HashMap.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_datatable_migrations_status
> models::GetDatatableMigrationsStatus200Response get_datatable_migrations_status(workspace, datatable_name)
list a datatable's migrations with their applied status
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | **String** | | [required] |
### Return type
[**models::GetDatatableMigrationsStatus200Response**](getDatatableMigrationsStatus_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_datatable_permissions
> models::DatatablePermissions get_datatable_permissions(workspace, datatable_name)
get who may connect to a data table as which role
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | **String** | | [required] |
### Return type
[**models::DatatablePermissions**](DatatablePermissions.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_default_scripts
> models::WorkspaceDefaultScripts get_default_scripts(workspace)
get default scripts for workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::WorkspaceDefaultScripts**](WorkspaceDefaultScripts.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_dependency_map
> Vec<models::DependencyMap> get_dependency_map(workspace)
get dependency map
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**Vec<models::DependencyMap>**](DependencyMap.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_dependents
> Vec<models::DependencyDependent> get_dependents(workspace, imported_path)
get dependents of an imported path
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**imported_path** | **String** | The imported path to get dependents for | [required] |
### Return type
[**Vec<models::DependencyDependent>**](DependencyDependent.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_dependents_amounts
> Vec<models::DependentsAmount> get_dependents_amounts(workspace, request_body)
get dependents amounts for multiple imported paths
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**request_body** | [**Vec<String>**](String.md) | List of imported paths to get dependents counts for | [required] |
### Return type
[**Vec<models::DependentsAmount>**](DependentsAmount.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_deploy_to
> models::GetDeployTo200Response get_deploy_to(workspace)
get the workspace this one deploys into (its fork parent)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::GetDeployTo200Response**](getDeployTo_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_dev_workspace
> models::GetDevWorkspace200Response get_dev_workspace(workspace)
this workspace's active canonical dev workspace, if any
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::GetDevWorkspace200Response**](getDevWorkspace_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_git_sync_deploy_mode
> models::GetGitSyncDeployMode200Response get_git_sync_deploy_mode(workspace, branch)
Get how local changes deploy to this workspace via git sync
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**branch** | Option<**String**> | The branch the caller would push. | |
### Return type
[**models::GetGitSyncDeployMode200Response**](getGitSyncDeployMode_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_git_sync_enabled
> models::GetGitSyncEnabled200Response get_git_sync_enabled(workspace)
Check if git sync is available for this workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::GetGitSyncEnabled200Response**](getGitSyncEnabled_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_github_app_repo_archive
> std::path::PathBuf get_github_app_repo_archive(workspace, path, r#ref)
download a gzipped tarball of a GitHub App repository
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**path** | **String** | | [required] |
**r#ref** | Option<**String**> | branch, tag or commit sha; defaults to the resource's branch | |
### Return type
[**std::path::PathBuf**](std::path::PathBuf.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/gzip
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_github_app_token
> models::GetGithubAppToken200Response get_github_app_token(workspace, get_github_app_token_request)
get the git credential for a git-sync job (GitHub App token, or the credential stored for the repository)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**get_github_app_token_request** | [**GetGithubAppTokenRequest**](GetGithubAppTokenRequest.md) | jwt job token | [required] |
### Return type
[**models::GetGithubAppToken200Response**](getGithubAppToken_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_guest_usage
> models::GuestUsage get_guest_usage(workspace)
the instance's standing against the guest allowance
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.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::GuestUsage**](GuestUsage.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_imports
> Vec<String> get_imports(workspace, importer_path)
get script imports for an importer path
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**importer_path** | **String** | The script path to get imports for | [required] |
### Return type
**Vec<String>**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_is_premium
> bool get_is_premium(workspace)
get if workspace is premium
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
**bool**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_open_deployment_request
> models::DeploymentRequest get_open_deployment_request(workspace)
get the currently open deployment request for this fork
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::DeploymentRequest**](DeploymentRequest.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_premium_info
> models::GetPremiumInfo200Response get_premium_info(workspace, skip_subscription_fetch)
get premium info
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**skip_subscription_fetch** | Option<**bool**> | skip fetching subscription status from stripe | |
### Return type
[**models::GetPremiumInfo200Response**](getPremiumInfo_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_public_settings
> models::GetPublicSettings200Response get_public_settings(workspace)
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`.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::GetPublicSettings200Response**](getPublicSettings_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_remote_deploy_target
> models::RemoteDeployStatus get_remote_deploy_target(workspace)
get the workspace's deploy target on another instance, and the caller's connection to it
Once connected, deploy calls aimed at the target go through `/w/{workspace}/remote_deploy/proxy/{proxy_key}/{route}`, which forwards any method to `{base_url}/api/w/{target workspace}/{route}` with the caller's stored token.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::RemoteDeployStatus**](RemoteDeployStatus.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_session_workspace_retention
> std::collections::HashMap<String, i32> get_session_workspace_retention(get_session_workspace_status_request)
get the AI session retention of workspaces referenced by client-side sessions
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**get_session_workspace_status_request** | [**GetSessionWorkspaceStatusRequest**](GetSessionWorkspaceStatusRequest.md) | | [required] |
### Return type
**std::collections::HashMap<String, i32>**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_session_workspace_status
> std::collections::HashMap<String, String> get_session_workspace_status(get_session_workspace_status_request)
get the lifecycle status of workspaces referenced by client-side sessions
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**get_session_workspace_status_request** | [**GetSessionWorkspaceStatusRequest**](GetSessionWorkspaceStatusRequest.md) | | [required] |
### Return type
**std::collections::HashMap<String, String>**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_settings
> models::GetSettings200Response get_settings(workspace)
get settings (admin only)
Returns the full workspace settings including admin-managed integration credentials. Admin-only — non-admin callers should use `getPublicSettings`.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::GetSettings200Response**](getSettings_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_shared_ui
> models::GetSharedUi200Response get_shared_ui(workspace)
get the workspace shared UI folder (full content)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::GetSharedUi200Response**](getSharedUi_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_shared_ui_version
> models::GetSharedUiVersion200Response get_shared_ui_version(workspace)
get the current version of the workspace shared UI folder
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::GetSharedUiVersion200Response**](getSharedUiVersion_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_threshold_alert
> models::GetThresholdAlert200Response get_threshold_alert(workspace)
get threshold alert info
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::GetThresholdAlert200Response**](getThresholdAlert_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_used_triggers
> models::GetUsedTriggers200Response get_used_triggers(workspace)
get used triggers
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::GetUsedTriggers200Response**](getUsedTriggers_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_workspace_as_super_admin
> models::Workspace get_workspace_as_super_admin(workspace)
get workspace as super admin (require to be super admin)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::Workspace**](Workspace.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_workspace_default_app
> models::GetWorkspaceDefaultApp200Response get_workspace_default_app(workspace)
get default app for workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::GetWorkspaceDefaultApp200Response**](getWorkspaceDefaultApp_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_workspace_encryption_key
> models::GetWorkspaceEncryptionKey200Response get_workspace_encryption_key(workspace)
retrieves the encryption key for this workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::GetWorkspaceEncryptionKey200Response**](getWorkspaceEncryptionKey_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_workspace_name
> String get_workspace_name(workspace)
get workspace name
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_workspace_slack_oauth_config
> models::GetWorkspaceSlackOauthConfig200Response get_workspace_slack_oauth_config(workspace)
get workspace slack oauth config
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::GetWorkspaceSlackOauthConfig200Response**](getWorkspaceSlackOauthConfig_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_workspace_usage
> f64 get_workspace_usage(workspace)
get usage
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
**f64**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## import_pg_database
> String import_pg_database(workspace, import_pg_database_request)
import a PostgreSQL database from source to target via pg_dump
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**import_pg_database_request** | [**ImportPgDatabaseRequest**](ImportPgDatabaseRequest.md) | Import pg database request | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## invite_user
> String invite_user(workspace, invite_user_request)
invite user to workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**invite_user_request** | [**InviteUserRequest**](InviteUserRequest.md) | WorkspaceInvite | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## is_domain_allowed
> bool is_domain_allowed()
is domain allowed for auto invi
### Parameters
This endpoint does not need any parameter.
### Return type
**bool**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## leave_workspace
> String leave_workspace(workspace)
leave workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_available_teams_channels
> models::ListAvailableTeamsChannels200Response list_available_teams_channels(workspace, team_id)
list available channels for a specific team
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**team_id** | **String** | Microsoft Teams team ID | [required] |
### Return type
[**models::ListAvailableTeamsChannels200Response**](listAvailableTeamsChannels_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_available_teams_ids
> models::ListAvailableTeamsIds200Response list_available_teams_ids(workspace, search, next_link)
list available teams ids
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**search** | Option<**String**> | Search teams by name. If omitted, returns first page of all teams. | |
**next_link** | Option<**String**> | Pagination cursor URL from previous response. Pass this to fetch the next page of results. | |
### Return type
[**models::ListAvailableTeamsIds200Response**](listAvailableTeamsIds_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_data_table_schemas
> Vec<models::DataTableSchema> list_data_table_schemas(workspace)
list schemas of all connected Datatables
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**Vec<models::DataTableSchema>**](DataTableSchema.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_data_table_tables
> Vec<models::DataTableTables> list_data_table_tables(workspace, datatable_name, role_for, role)
list tables of all connected Datatables
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | Option<**String**> | list only this data table; each listed data table opens a connection to its database | |
**role_for** | Option<**String**> | the data table `role` applies to; every other one is listed as its default role | |
**role** | Option<**String**> | the role to list `role_for` as; refused, in that entry's `error`, if the caller may not use it | |
### Return type
[**Vec<models::DataTableTables>**](DataTableTables.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_data_tables
> Vec<models::ListDataTables200ResponseInner> list_data_tables(workspace)
list Datatables
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**Vec<models::ListDataTables200ResponseInner>**](listDataTables_200_response_inner.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_datatable_migrations
> Vec<models::DatatableMigration> list_datatable_migrations(workspace)
list datatable migrations for a workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**Vec<models::DatatableMigration>**](DatatableMigration.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_deployment_request_eligible_deployers
> Vec<models::DeploymentRequestEligibleDeployer> list_deployment_request_eligible_deployers(workspace)
list users eligible to be deployment request assignees
Returns admins and members of wm_deployers in the parent workspace of the fork at `{workspace}`.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**Vec<models::DeploymentRequestEligibleDeployer>**](DeploymentRequestEligibleDeployer.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_ducklakes
> Vec<String> list_ducklakes(workspace)
list ducklakes
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
**Vec<String>**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_pending_invites
> Vec<models::WorkspaceInvite> list_pending_invites(workspace)
list pending invites for a workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**Vec<models::WorkspaceInvite>**](WorkspaceInvite.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_protection_rules
> Vec<models::ProtectionRuleset> list_protection_rules(workspace)
list all protection rules for a workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**Vec<models::ProtectionRuleset>**](ProtectionRuleset.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_shared_ui
> models::ListSharedUi200Response list_shared_ui(workspace)
list paths/sizes of the workspace shared UI folder
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**models::ListSharedUi200Response**](listSharedUi_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_usable_datatable_roles
> models::ListUsableDatatableRoles200Response list_usable_datatable_roles(workspace, datatable_name)
list the data table roles the caller may connect as
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | **String** | | [required] |
### Return type
[**models::ListUsableDatatableRoles200Response**](listUsableDatatableRoles_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_user_workspaces
> models::UserWorkspaceList list_user_workspaces()
list all workspaces visible to me with user info
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::UserWorkspaceList**](UserWorkspaceList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_workspaces
> Vec<models::Workspace> list_workspaces()
list all workspaces visible to me
### Parameters
This endpoint does not need any parameter.
### Return type
[**Vec<models::Workspace>**](Workspace.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_workspaces_as_super_admin
> Vec<models::Workspace> list_workspaces_as_super_admin(page, per_page)
list all workspaces as super admin (require to be super admin)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page** | Option<**i32**> | which page to return (start at 1, default 1) | |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) | |
### Return type
[**Vec<models::Workspace>**](Workspace.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_ws_specific
> Vec<models::ListWsSpecific200ResponseInner> list_ws_specific(workspace)
list all workspace-specific items
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
[**Vec<models::ListWsSpecific200ResponseInner>**](listWsSpecific_200_response_inner.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_ws_specific_versions
> Vec<String> list_ws_specific_versions(workspace, kind, path)
list workspace ids that have a version of the given item
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**kind** | **String** | | [required] |
**path** | **String** | | [required] |
### Return type
**Vec<String>**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## log_feature_usage
> log_feature_usage(workspace, log_feature_usage_request)
log anonymous feature usage telemetry events
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**log_feature_usage_request** | [**LogFeatureUsageRequest**](LogFeatureUsageRequest.md) | | [required] |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## plan_datatable_acl
> models::AclPlan plan_datatable_acl(workspace, datatable_name, acl_change_request)
preview the SQL an ownership or grant change would run (data table administrators only)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | **String** | | [required] |
**acl_change_request** | [**AclChangeRequest**](AclChangeRequest.md) | | [required] |
### Return type
[**models::AclPlan**](AclPlan.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## prune_versions
> models::PruneVersions200Response prune_versions(workspace, prune_versions_request)
prune old versions of scripts, flows, apps, or resources
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**prune_versions_request** | [**PruneVersionsRequest**](PruneVersionsRequest.md) | | [required] |
### Return type
[**models::PruneVersions200Response**](pruneVersions_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## rebuild_dependency_map
> String rebuild_dependency_map(workspace)
rebuild dependency map
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## reset_diff_tally
> serde_json::Value reset_diff_tally(workspace, fork_workspace_id)
Resets the ahead and behind deployement counter after a deployement
This endpoint should be called after a fork deployement
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**fork_workspace_id** | **String** | The ID of the workspace to compare with | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## rollback_datatable_migrations
> models::RollbackDatatableMigrations200Response rollback_datatable_migrations(workspace, datatable_name, only)
roll back the most recently applied migration on a datatable
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | **String** | | [required] |
**only** | Option<**i64**> | roll back this specific applied migration version instead of the latest | |
### Return type
[**models::RollbackDatatableMigrations200Response**](rollbackDatatableMigrations_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## run_datatable_migrations
> models::RunDatatableMigrations200Response run_datatable_migrations(workspace, datatable_name, up_to, only)
run pending datatable migrations against a datatable
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | **String** | | [required] |
**up_to** | Option<**i64**> | only apply pending migrations up to and including this version | |
**only** | Option<**i64**> | apply only this specific migration version, ignoring others | |
### Return type
[**models::RunDatatableMigrations200Response**](runDatatableMigrations_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## run_slack_message_test_job
> models::RunSlackMessageTestJob200Response run_slack_message_test_job(workspace, run_slack_message_test_job_request)
run a job that sends a message to Slack
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**run_slack_message_test_job_request** | [**RunSlackMessageTestJobRequest**](RunSlackMessageTestJobRequest.md) | path to hub script to run and its corresponding args | [required] |
### Return type
[**models::RunSlackMessageTestJob200Response**](runSlackMessageTestJob_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## run_teams_message_test_job
> models::RunSlackMessageTestJob200Response run_teams_message_test_job(workspace, run_slack_message_test_job_request)
run a job that sends a message to Teams
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**run_slack_message_test_job_request** | [**RunSlackMessageTestJobRequest**](RunSlackMessageTestJobRequest.md) | path to hub script to run and its corresponding args | [required] |
### Return type
[**models::RunSlackMessageTestJob200Response**](runSlackMessageTestJob_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## seed_full_diff_scan
> models::SeedFullDiffScan200Response seed_full_diff_scan(workspace, target_workspace_id)
Seed the diff candidate set against an arbitrary workspace
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.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**target_workspace_id** | **String** | The ID of the workspace to compare with | [required] |
### Return type
[**models::SeedFullDiffScan200Response**](seedFullDiffScan_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## set_datatable_permissions
> String set_datatable_permissions(workspace, datatable_name, set_datatable_permissions_request)
set who may connect to a data table as which role
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | **String** | | [required] |
**set_datatable_permissions_request** | [**SetDatatablePermissionsRequest**](SetDatatablePermissionsRequest.md) | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## set_environment_variable
> String set_environment_variable(workspace, set_environment_variable_request)
set environment variable
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**set_environment_variable_request** | [**SetEnvironmentVariableRequest**](SetEnvironmentVariableRequest.md) | Workspace default app | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## set_remote_deploy_target
> String set_remote_deploy_target(workspace, set_remote_deploy_target_request)
set or clear the workspace's deploy target on another instance
Changing the target drops every token stored for the previous one.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**set_remote_deploy_target_request** | [**SetRemoteDeployTargetRequest**](SetRemoteDeployTargetRequest.md) | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## set_threshold_alert
> String set_threshold_alert(workspace, set_threshold_alert_request)
set threshold alert info
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**set_threshold_alert_request** | [**SetThresholdAlertRequest**](SetThresholdAlertRequest.md) | threshold alert info | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## set_workspace_encryption_key
> String set_workspace_encryption_key(workspace, set_workspace_encryption_key_request)
update the encryption key for this workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**set_workspace_encryption_key_request** | [**SetWorkspaceEncryptionKeyRequest**](SetWorkspaceEncryptionKeyRequest.md) | New encryption key | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## set_workspace_slack_oauth_config
> String set_workspace_slack_oauth_config(workspace, set_workspace_slack_oauth_config_request)
set workspace slack oauth config
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**set_workspace_slack_oauth_config_request** | [**SetWorkspaceSlackOauthConfigRequest**](SetWorkspaceSlackOauthConfigRequest.md) | Slack OAuth Configuration | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## set_ws_specific
> String set_ws_specific(workspace, set_ws_specific_request)
mark or unmark an item as workspace-specific
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**set_ws_specific_request** | [**SetWsSpecificRequest**](SetWsSpecificRequest.md) | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## test_data_table_connection
> models::TestDataTableConnection200Response test_data_table_connection(workspace, datatable_name)
check what the data table's database lets its role do
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | **String** | | [required] |
### Return type
[**models::TestDataTableConnection200Response**](testDataTableConnection_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## unarchive_workspace
> String unarchive_workspace(workspace)
unarchive workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## update_operator_settings
> String update_operator_settings(workspace, operator_settings)
Update operator settings for a workspace
Updates the operator settings for a specific workspace. Requires workspace admin privileges.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**operator_settings** | Option<[**OperatorSettings**](OperatorSettings.md)> | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## update_protection_rule
> String update_protection_rule(workspace, rule_name, update_protection_rule_request)
update an existing protection rule
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**rule_name** | **String** | Name of the protection rule to update | [required] |
**update_protection_rule_request** | [**UpdateProtectionRuleRequest**](UpdateProtectionRuleRequest.md) | Updated protection rule configuration | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## update_shared_ui
> String update_shared_ui(workspace, update_shared_ui_request)
replace the workspace shared UI folder (admin only)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**update_shared_ui_request** | [**UpdateSharedUiRequest**](UpdateSharedUiRequest.md) | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## upsert_datatable_migration
> String upsert_datatable_migration(workspace, datatable_name, upsert_datatable_migration_request)
insert or update a single datatable migration at an explicit version
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**datatable_name** | **String** | | [required] |
**upsert_datatable_migration_request** | [**UpsertDatatableMigrationRequest**](UpsertDatatableMigrationRequest.md) | | [required] |
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)