# \WorkspaceApi
All URIs are relative to */api*
[**add_user**](WorkspaceApi.md#add_user) | **POST** /w/{workspace}/workspaces/add_user | add user to workspace
[**archive_workspace**](WorkspaceApi.md#archive_workspace) | **POST** /w/{workspace}/workspaces/archive | archive workspace
[**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
[**connect_teams**](WorkspaceApi.md#connect_teams) | **POST** /w/{workspace}/workspaces/connect_teams | connect teams
[**create_workspace**](WorkspaceApi.md#create_workspace) | **POST** /workspaces/create | create workspace
[**create_workspace_fork**](WorkspaceApi.md#create_workspace_fork) | **POST** /workspaces/create_fork | create forked workspace
[**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_workspace**](WorkspaceApi.md#delete_workspace) | **DELETE** /workspaces/delete/{workspace} | delete workspace (require super admin)
[**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_default_scripts**](WorkspaceApi.md#edit_default_scripts) | **POST** /w/{workspace}/workspaces/default_scripts | edit default scripts for workspace
[**edit_deploy_to**](WorkspaceApi.md#edit_deploy_to) | **POST** /w/{workspace}/workspaces/edit_deploy_to | edit deploy to
[**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_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_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
[**exists_username**](WorkspaceApi.md#exists_username) | **POST** /workspaces/exists_username | exists username
[**exists_workspace**](WorkspaceApi.md#exists_workspace) | **POST** /workspaces/exists | exists workspace
[**get_copilot_info**](WorkspaceApi.md#get_copilot_info) | **GET** /w/{workspace}/workspaces/get_copilot_info | get copilot info
[**get_default_scripts**](WorkspaceApi.md#get_default_scripts) | **GET** /w/{workspace}/workspaces/default_scripts | get default scripts for workspace
[**get_deploy_to**](WorkspaceApi.md#get_deploy_to) | **GET** /w/{workspace}/workspaces/get_deploy_to | get deploy to
[**get_github_app_token**](WorkspaceApi.md#get_github_app_token) | **POST** /w/{workspace}/github_app/token | get github app token
[**get_is_premium**](WorkspaceApi.md#get_is_premium) | **GET** /w/{workspace}/workspaces/is_premium | get if workspace is premium
[**get_large_file_storage_config**](WorkspaceApi.md#get_large_file_storage_config) | **GET** /w/{workspace}/workspaces/get_large_file_storage_config | get large file storage config
[**get_premium_info**](WorkspaceApi.md#get_premium_info) | **GET** /w/{workspace}/workspaces/premium_info | get premium info
[**get_settings**](WorkspaceApi.md#get_settings) | **GET** /w/{workspace}/workspaces/get_settings | get settings
[**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_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_usage**](WorkspaceApi.md#get_workspace_usage) | **GET** /w/{workspace}/workspaces/usage | get usage
[**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 teams channels
[**list_available_teams_ids**](WorkspaceApi.md#list_available_teams_ids) | **GET** /w/{workspace}/workspaces/available_teams_ids | list available teams ids
[**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_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)
[**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
[**set_environment_variable**](WorkspaceApi.md#set_environment_variable) | **POST** /w/{workspace}/workspaces/set_environment_variable | set environment variable
[**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
[**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
## add_user
> String add_user(workspace, add_user_request)
add user to workspace
### Parameters
**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)
## archive_workspace
> String archive_workspace(workspace)
archive workspace
### Parameters
**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)
## change_workspace_color
> String change_workspace_color(workspace, change_workspace_color_request)
change workspace id
### Parameters
**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
**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
**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)
## connect_teams
> String connect_teams(workspace, connect_teams_request)
connect teams
### Parameters
**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_workspace
> String create_workspace(create_workspace)
create workspace
### Parameters
**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(create_workspace_fork)
create forked workspace
### Parameters
**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)
## delete_git_sync_repository
> serde_json::Value delete_git_sync_repository(workspace, delete_git_sync_repository_request)
delete individual git sync repository
### Parameters
**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
**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_workspace
> String delete_workspace(workspace)
delete workspace (require super admin)
### Parameters
**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)
## edit_auto_invite
> String edit_auto_invite(workspace, edit_auto_invite_request)
edit auto invite
### Parameters
**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
> String edit_copilot_config(workspace, ai_config)
edit copilot config
### Parameters
**workspace** | **String** | | [required] |
**ai_config** | [**AiConfig**](AiConfig.md) | WorkspaceCopilotConfig | [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_default_scripts
> String edit_default_scripts(workspace, workspace_default_scripts)
edit default scripts for workspace
### Parameters
**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_deploy_to
> String edit_deploy_to(workspace, get_deploy_to200_response)
edit deploy to
### Parameters
**workspace** | **String** | | [required] |
**get_deploy_to200_response** | [**GetDeployTo200Response**](GetDeployTo200Response.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)
## edit_ducklake_config
> serde_json::Value edit_ducklake_config(workspace, edit_ducklake_config_request)
edit ducklake settings
### Parameters
**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_request)
edit error handler
### Parameters
**workspace** | **String** | | [required] |
**edit_error_handler_request** | [**EditErrorHandlerRequest**](EditErrorHandlerRequest.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
**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_instance_groups
> String edit_instance_groups(workspace, edit_instance_groups_request)
edit instance groups
### Parameters
**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
**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
**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_teams_command
> String edit_teams_command(workspace, edit_slack_command_request)
edit teams command
### Parameters
**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
**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
**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
**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
**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)
## exists_username
> bool exists_username(exists_username_request)
exists username
### Parameters
**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
**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)
## get_copilot_info
> models::AiConfig get_copilot_info(workspace)
get copilot info
### Parameters
**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_default_scripts
> models::WorkspaceDefaultScripts get_default_scripts(workspace)
get default scripts for workspace
### Parameters
**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_deploy_to
> models::GetDeployTo200Response get_deploy_to(workspace)
get deploy to
### Parameters
**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_github_app_token
> models::GetGithubAppToken200Response get_github_app_token(workspace, get_github_app_token_request)
get github app token
### Parameters
**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_is_premium
> bool get_is_premium(workspace)
get if workspace is premium
### Parameters
**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_large_file_storage_config
> models::LargeFileStorage get_large_file_storage_config(workspace)
get large file storage config
### Parameters
**workspace** | **String** | | [required] |
### Return type
[**models::LargeFileStorage**](LargeFileStorage.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
**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_settings
> models::GetSettings200Response get_settings(workspace)
get settings
### Parameters
**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_threshold_alert
> models::GetThresholdAlert200Response get_threshold_alert(workspace)
get threshold alert info
### Parameters
**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
**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_default_app
> models::EditWorkspaceDefaultAppRequest get_workspace_default_app(workspace)
get default app for workspace
### Parameters
**workspace** | **String** | | [required] |
### Return type
[**models::EditWorkspaceDefaultAppRequest**](editWorkspaceDefaultApp_request.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
**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
**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_usage
> f64 get_workspace_usage(workspace)
get usage
### Parameters
**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)
## invite_user
> String invite_user(workspace, invite_user_request)
invite user to workspace
### Parameters
**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
**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
> Vec<models::ListAvailableTeamsChannels200ResponseInner> list_available_teams_channels(workspace)
list available teams channels
### Parameters
**workspace** | **String** | | [required] |
### Return type
[**Vec<models::ListAvailableTeamsChannels200ResponseInner>**](listAvailableTeamsChannels_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_available_teams_ids
> Vec<models::ListAvailableTeamsIds200ResponseInner> list_available_teams_ids(workspace)
list available teams ids
### Parameters
**workspace** | **String** | | [required] |
### Return type
[**Vec<models::ListAvailableTeamsIds200ResponseInner>**](listAvailableTeamsIds_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_ducklakes
> Vec<String> list_ducklakes(workspace)
list ducklakes
### Parameters
**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
**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_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
**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)
## 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
**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
**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)
## set_environment_variable
> String set_environment_variable(workspace, set_environment_variable_request)
set environment variable
### Parameters
**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_threshold_alert
> String set_threshold_alert(workspace, set_threshold_alert_request)
set threshold alert info
### Parameters
**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
**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)
## unarchive_workspace
> String unarchive_workspace(workspace)
unarchive workspace
### Parameters
**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
**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)