# \SettingApi
All URIs are relative to */api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**acknowledge_all_critical_alerts**](SettingApi.md#acknowledge_all_critical_alerts) | **POST** /settings/critical_alerts/acknowledge_all | Acknowledge all unacknowledged critical alerts
[**acknowledge_critical_alert**](SettingApi.md#acknowledge_critical_alert) | **POST** /settings/critical_alerts/{id}/acknowledge | Acknowledge a critical alert
[**compute_object_storage_usage**](SettingApi.md#compute_object_storage_usage) | **POST** /settings/object_storage_usage | start a background computation of object storage usage by top-level folder
[**delete_saml_config**](SettingApi.md#delete_saml_config) | **DELETE** /saml/config | delete SAML SSO configuration
[**drop_custom_instance_db**](SettingApi.md#drop_custom_instance_db) | **POST** /settings/drop_custom_instance_pg_database/{name} | Drops a custom instance database (superadmin only, irreversible)
[**get_critical_alerts**](SettingApi.md#get_critical_alerts) | **GET** /settings/critical_alerts | Get all critical alerts
[**get_global**](SettingApi.md#get_global) | **GET** /settings/global/{key} | get global settings
[**get_instance_config**](SettingApi.md#get_instance_config) | **GET** /settings/instance_config | get full instance config (global settings + worker configs)
[**get_jwks**](SettingApi.md#get_jwks) | **GET** /.well-known/jwks.json | get JWKS for Vault JWT authentication
[**get_latest_key_renewal_attempt**](SettingApi.md#get_latest_key_renewal_attempt) | **GET** /settings/latest_key_renewal_attempt | get latest key renewal attempt
[**get_local**](SettingApi.md#get_local) | **GET** /settings/local | get local settings
[**get_log_cleanup_status**](SettingApi.md#get_log_cleanup_status) | **GET** /settings/log_cleanup_status | get status of the manual log cleanup task
[**get_min_keep_alive_version**](SettingApi.md#get_min_keep_alive_version) | **GET** /min_keep_alive_version | get minimum worker versions required to stay alive
[**get_object_storage_usage**](SettingApi.md#get_object_storage_usage) | **GET** /settings/object_storage_usage | get current or last object storage usage computation (null if never run)
[**get_ruff_config**](SettingApi.md#get_ruff_config) | **GET** /settings_u/ruff_config | get instance ruff config (unauthenticated)
[**get_runtime_usage**](SettingApi.md#get_runtime_usage) | **GET** /settings/runtime_usage | instance-wide count of scripts/flows per language (superadmin only)
[**get_runtime_usage_locations**](SettingApi.md#get_runtime_usage_locations) | **GET** /settings/runtime_usage/{language} | concrete (capped) locations using a language, instance-wide (superadmin only)
[**get_saml_config**](SettingApi.md#get_saml_config) | **GET** /saml/config | get SAML SSO configuration
[**get_saml_sp_metadata**](SettingApi.md#get_saml_sp_metadata) | **GET** /saml/metadata | get SAML SP metadata
[**get_secondary_storage_names**](SettingApi.md#get_secondary_storage_names) | **GET** /w/{workspace}/workspaces/get_secondary_storage_names | get secondary storage names
[**get_stats**](SettingApi.md#get_stats) | **GET** /settings/get_stats | get telemetry stats with HMAC signature (Business)
[**initiate_saml_login**](SettingApi.md#initiate_saml_login) | **POST** /saml/initiate | start an SP-initiated SAML login
[**initiate_saml_login_get**](SettingApi.md#initiate_saml_login_get) | **GET** /saml/initiate | start an SP-initiated SAML login
[**list_custom_instance_dbs**](SettingApi.md#list_custom_instance_dbs) | **POST** /settings/list_custom_instance_pg_databases | Returns the set-up statuses of custom instance pg databases
[**list_global_settings**](SettingApi.md#list_global_settings) | **GET** /settings/list_global | list global settings
[**list_workspace_licences**](SettingApi.md#list_workspace_licences) | **GET** /settings/workspace_licences | list every workspace's licence and its state
[**migrate_secrets_from_aws_sm**](SettingApi.md#migrate_secrets_from_aws_sm) | **POST** /settings/migrate_secrets_from_aws_sm | migrate secrets from AWS Secrets Manager to database
[**migrate_secrets_from_azure_kv**](SettingApi.md#migrate_secrets_from_azure_kv) | **POST** /settings/migrate_secrets_from_azure_kv | migrate secrets from Azure Key Vault to database
[**migrate_secrets_to_aws_sm**](SettingApi.md#migrate_secrets_to_aws_sm) | **POST** /settings/migrate_secrets_to_aws_sm | migrate secrets from database to AWS Secrets Manager
[**migrate_secrets_to_azure_kv**](SettingApi.md#migrate_secrets_to_azure_kv) | **POST** /settings/migrate_secrets_to_azure_kv | migrate secrets from database to Azure Key Vault
[**migrate_secrets_to_database**](SettingApi.md#migrate_secrets_to_database) | **POST** /settings/migrate_secrets_to_database | migrate secrets from HashiCorp Vault to database
[**migrate_secrets_to_vault**](SettingApi.md#migrate_secrets_to_vault) | **POST** /settings/migrate_secrets_to_vault | migrate secrets from database to HashiCorp Vault
[**refresh_custom_instance_user_pwd**](SettingApi.md#refresh_custom_instance_user_pwd) | **POST** /settings/refresh_custom_instance_user_pwd | Refreshes the password for the custom_instance_user
[**refresh_workspace_licences**](SettingApi.md#refresh_workspace_licences) | **POST** /settings/refresh_workspace_licences | refresh managed-mode workspace licences now
[**renew_license_key**](SettingApi.md#renew_license_key) | **POST** /settings/renew_license_key | renew license key
[**restart_worker_group**](SettingApi.md#restart_worker_group) | **POST** /settings/restart_worker_group/{worker_group} | restart worker group
[**restart_worker_pool**](SettingApi.md#restart_worker_pool) | **POST** /settings/restart_worker_pool/{worker_pool} | restart worker pool
[**revalidate_license**](SettingApi.md#revalidate_license) | **POST** /settings/revalidate_license | force an immediate licence revalidation
[**run_log_cleanup**](SettingApi.md#run_log_cleanup) | **POST** /settings/run_log_cleanup | start a manual cleanup of expired logs from object storage
[**save_saml_config**](SettingApi.md#save_saml_config) | **POST** /saml/config | save SAML SSO configuration
[**send_stats**](SettingApi.md#send_stats) | **POST** /settings/send_stats | send stats
[**set_global**](SettingApi.md#set_global) | **POST** /settings/global/{key} | post global settings
[**set_instance_config**](SettingApi.md#set_instance_config) | **PUT** /settings/instance_config | update instance config (bulk upsert, no deletes). Empty or missing global_settings/worker_configs are skipped.
[**setup_custom_instance_db**](SettingApi.md#setup_custom_instance_db) | **POST** /settings/setup_custom_instance_pg_database/{name} | Runs CREATE DATABASE on the Orvanta Postgres and grants access to the custom_instance_user
[**test_aws_sm_backend**](SettingApi.md#test_aws_sm_backend) | **POST** /settings/test_aws_sm_backend | test connection to AWS Secrets Manager
[**test_azure_kv_backend**](SettingApi.md#test_azure_kv_backend) | **POST** /settings/test_azure_kv_backend | test Azure Key Vault connection
[**test_critical_channels**](SettingApi.md#test_critical_channels) | **POST** /settings/test_critical_channels | test critical channels
[**test_license_key**](SettingApi.md#test_license_key) | **POST** /settings/test_license_key | test license key
[**test_metadata**](SettingApi.md#test_metadata) | **POST** /saml/test_metadata | test metadata
[**test_object_storage_config**](SettingApi.md#test_object_storage_config) | **POST** /settings/test_object_storage_config | test object storage config
[**test_secret_backend**](SettingApi.md#test_secret_backend) | **POST** /settings/test_secret_backend | test secret backend connection (HashiCorp Vault)
[**test_smtp**](SettingApi.md#test_smtp) | **POST** /settings/test_smtp | test smtp
[**update_saml_metadata**](SettingApi.md#update_saml_metadata) | **POST** /saml/update_metadata | refresh SAML IdP metadata from the configured idp_metadata_url
[**workspace_acknowledge_all_critical_alerts**](SettingApi.md#workspace_acknowledge_all_critical_alerts) | **POST** /w/{workspace}/workspaces/critical_alerts/acknowledge_all | Acknowledge all unacknowledged critical alerts for this workspace
[**workspace_acknowledge_critical_alert**](SettingApi.md#workspace_acknowledge_critical_alert) | **POST** /w/{workspace}/workspaces/critical_alerts/{id}/acknowledge | Acknowledge a critical alert for this workspace
[**workspace_get_critical_alerts**](SettingApi.md#workspace_get_critical_alerts) | **GET** /w/{workspace}/workspaces/critical_alerts | Get all critical alerts for this workspace
[**workspace_mute_critical_alerts_ui**](SettingApi.md#workspace_mute_critical_alerts_ui) | **POST** /w/{workspace}/workspaces/critical_alerts/mute | Mute critical alert UI for this workspace
## acknowledge_all_critical_alerts
> String acknowledge_all_critical_alerts()
Acknowledge all unacknowledged critical alerts
### Parameters
This endpoint does not need any parameter.
### Return type
**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)
## acknowledge_critical_alert
> String acknowledge_critical_alert(id)
Acknowledge a critical alert
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the critical alert to acknowledge | [required] |
### Return type
**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)
## compute_object_storage_usage
> String compute_object_storage_usage()
start a background computation of object storage usage by top-level folder
### Parameters
This endpoint does not need any parameter.
### 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_saml_config
> String delete_saml_config()
delete SAML SSO configuration
### Parameters
This endpoint does not need any parameter.
### 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_custom_instance_db
> String drop_custom_instance_db(name)
Drops a custom instance database (superadmin only, irreversible)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | The name of the database to drop | [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_critical_alerts
> models::GetCriticalAlerts200Response get_critical_alerts(page, page_size, acknowledged)
Get all critical alerts
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page** | Option<**i32**> | | |[default to 1]
**page_size** | Option<**i32**> | | |[default to 10]
**acknowledged** | Option<**bool**> | | |
### Return type
[**models::GetCriticalAlerts200Response**](getCriticalAlerts_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_global
> serde_json::Value get_global(key)
get global settings
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**key** | **String** | | [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)
## get_instance_config
> models::InstanceConfig get_instance_config()
get full instance config (global settings + worker configs)
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::InstanceConfig**](InstanceConfig.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_jwks
> models::JwksResponse get_jwks()
get JWKS for Vault JWT authentication
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::JwksResponse**](JwksResponse.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_latest_key_renewal_attempt
> models::GetLatestKeyRenewalAttempt200Response get_latest_key_renewal_attempt()
get latest key renewal attempt
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::GetLatestKeyRenewalAttempt200Response**](getLatestKeyRenewalAttempt_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_local
> serde_json::Value get_local()
get local settings
### Parameters
This endpoint does not need any parameter.
### 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)
## get_log_cleanup_status
> models::GetLogCleanupStatus200Response get_log_cleanup_status()
get status of the manual log cleanup task
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::GetLogCleanupStatus200Response**](getLogCleanupStatus_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_min_keep_alive_version
> models::GetMinKeepAliveVersion200Response get_min_keep_alive_version()
get minimum worker versions required to stay alive
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::GetMinKeepAliveVersion200Response**](getMinKeepAliveVersion_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_object_storage_usage
> models::GetObjectStorageUsage200Response get_object_storage_usage()
get current or last object storage usage computation (null if never run)
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::GetObjectStorageUsage200Response**](getObjectStorageUsage_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_ruff_config
> String get_ruff_config()
get instance ruff config (unauthenticated)
Returns the instance-level ruff.toml content as plain text. Intentionally unauthenticated so the LSP extra container can poll it across any deployment topology. Responds with an empty body when the instance config is unset. Ruff configuration is lint/format policy, not a credential.
### Parameters
This endpoint does not need any parameter.
### 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_runtime_usage
> Vec<models::RuntimeUsageCount> get_runtime_usage()
instance-wide count of scripts/flows per language (superadmin only)
Powers the Runtimes admin page (#190/#255 runtime governance) — for each language currently in use anywhere on the instance, how many scripts and flows use it. A language with no usage is simply absent from the response.
### Parameters
This endpoint does not need any parameter.
### Return type
[**Vec<models::RuntimeUsageCount>**](RuntimeUsageCount.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_runtime_usage_locations
> Vec<models::RuntimeUsageLocation> get_runtime_usage_locations(language)
concrete (capped) locations using a language, instance-wide (superadmin only)
Powers the block-on-disable instructive message (#190/#255) — where a language an admin is about to disable is still used, so they know what to migrate first. Capped per object kind on a large instance.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**language** | [**ScriptLang**](.md) | | [required] |
### Return type
[**Vec<models::RuntimeUsageLocation>**](RuntimeUsageLocation.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_saml_config
> models::SamlConfig get_saml_config()
get SAML SSO configuration
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::SamlConfig**](SamlConfig.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_saml_sp_metadata
> String get_saml_sp_metadata()
get SAML SP metadata
### Parameters
This endpoint does not need any parameter.
### Return type
**String**
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/samlmetadata+xml
[[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_secondary_storage_names
> Vec<String> get_secondary_storage_names(workspace, include_default)
get secondary storage names
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**include_default** | Option<**bool**> | If true, include \"_default_\" in the list if primary workspace storage is set | |[default to false]
### 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_stats
> models::GetStats200Response get_stats()
get telemetry stats with HMAC signature (Business)
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::GetStats200Response**](getStats_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)
## initiate_saml_login
> initiate_saml_login(relay_state)
start an SP-initiated SAML login
Mints a single-use, TTL'd AuthnRequest ID, records it server-side, sets it as a browser-bound cookie, and redirects to the IdP's SingleSignOnService with a `<samlp:AuthnRequest>` on the HTTP-Redirect binding. `POST /saml/acs` then requires the assertion's `InResponseTo` to match that ID, which is what binds the login to this browser (#589). Unauthenticated — this is the login entry point. Also available on GET so the sign-in page can hand off with a plain navigation.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**relay_state** | Option<**String**> | Post-login redirect target, constrained to a same-origin relative path. Held server-side against the request ID; never sent to the IdP. | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **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)
## initiate_saml_login_get
> initiate_saml_login_get(relay_state)
start an SP-initiated SAML login
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**relay_state** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **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)
## list_custom_instance_dbs
> std::collections::HashMap<String, models::CustomInstanceDb> list_custom_instance_dbs()
Returns the set-up statuses of custom instance pg databases
### Parameters
This endpoint does not need any parameter.
### Return type
[**std::collections::HashMap<String, models::CustomInstanceDb>**](CustomInstanceDb.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_global_settings
> Vec<models::GlobalSetting> list_global_settings()
list global settings
### Parameters
This endpoint does not need any parameter.
### Return type
[**Vec<models::GlobalSetting>**](GlobalSetting.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_workspace_licences
> models::ListWorkspaceLicences200Response list_workspace_licences(page, per_page)
list every workspace's licence and its state
Managed licence mode (#1753): every workspace and every licence binding, with the state each resolves to. Superadmin only. Empty in instance mode, where the instance licence answers for every workspace. Refresh with `POST /settings/refresh_workspace_licences`. Paginated (#1953), ordered by workspace id; `total` counts all of them.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page** | Option<**i32**> | Page number (default 1) | |
**per_page** | Option<**i32**> | Entries per page (default 1000, at most 10000) | |
### Return type
[**models::ListWorkspaceLicences200Response**](listWorkspaceLicences_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)
## migrate_secrets_from_aws_sm
> models::SecretMigrationReport migrate_secrets_from_aws_sm(aws_secrets_manager_settings)
migrate secrets from AWS Secrets Manager to database
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**aws_secrets_manager_settings** | [**AwsSecretsManagerSettings**](AwsSecretsManagerSettings.md) | | [required] |
### Return type
[**models::SecretMigrationReport**](SecretMigrationReport.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)
## migrate_secrets_from_azure_kv
> models::SecretMigrationReport migrate_secrets_from_azure_kv(azure_key_vault_settings)
migrate secrets from Azure Key Vault to database
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**azure_key_vault_settings** | [**AzureKeyVaultSettings**](AzureKeyVaultSettings.md) | Azure Key Vault settings for migration source | [required] |
### Return type
[**models::SecretMigrationReport**](SecretMigrationReport.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)
## migrate_secrets_to_aws_sm
> models::SecretMigrationReport migrate_secrets_to_aws_sm(aws_secrets_manager_settings)
migrate secrets from database to AWS Secrets Manager
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**aws_secrets_manager_settings** | [**AwsSecretsManagerSettings**](AwsSecretsManagerSettings.md) | | [required] |
### Return type
[**models::SecretMigrationReport**](SecretMigrationReport.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)
## migrate_secrets_to_azure_kv
> models::SecretMigrationReport migrate_secrets_to_azure_kv(azure_key_vault_settings)
migrate secrets from database to Azure Key Vault
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**azure_key_vault_settings** | [**AzureKeyVaultSettings**](AzureKeyVaultSettings.md) | Azure Key Vault settings for migration target | [required] |
### Return type
[**models::SecretMigrationReport**](SecretMigrationReport.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)
## migrate_secrets_to_database
> models::SecretMigrationReport migrate_secrets_to_database(vault_settings)
migrate secrets from HashiCorp Vault to database
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**vault_settings** | [**VaultSettings**](VaultSettings.md) | Vault settings for migration source | [required] |
### Return type
[**models::SecretMigrationReport**](SecretMigrationReport.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)
## migrate_secrets_to_vault
> models::SecretMigrationReport migrate_secrets_to_vault(vault_settings)
migrate secrets from database to HashiCorp Vault
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**vault_settings** | [**VaultSettings**](VaultSettings.md) | Vault settings for migration target | [required] |
### Return type
[**models::SecretMigrationReport**](SecretMigrationReport.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)
## refresh_custom_instance_user_pwd
> serde_json::Value refresh_custom_instance_user_pwd()
Refreshes the password for the custom_instance_user
### Parameters
This endpoint does not need any parameter.
### 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)
## refresh_workspace_licences
> models::RefreshWorkspaceLicences200Response refresh_workspace_licences(apply_pending_revocations)
refresh managed-mode workspace licences now
Managed licence mode (#1750): fetch every workspace's signed licence from the licence service with the host key, verify and store the genuine ones, and mark workspaces the service no longer serves. Superadmin only. A no-op in instance mode. A response that would revoke more than half of the live workspace licences at once is held back by the mass-revocation guard (reported in `mass_revocation_refused`); those workspaces then reach Trial and read-only through the ladder, at most ~96h after their last refresh.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**apply_pending_revocations** | Option<**bool**> | Superadmin override of the mass-revocation guard: apply this response's revocations in full. Use only once the revocation is confirmed genuine (see docs/managed-licence-runbook.md). | |
### Return type
[**models::RefreshWorkspaceLicences200Response**](refreshWorkspaceLicences_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)
## renew_license_key
> String renew_license_key(license_key)
renew license key
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**license_key** | Option<**String**> | | |
### 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)
## restart_worker_group
> String restart_worker_group(worker_group)
restart worker group
Send a restart signal to all workers in the specified worker group. Workers will gracefully shut down and are expected to be restarted by their supervisor. Requires devops role. Deprecated (#370): use POST /settings/restart_worker_pool/{worker_pool} instead.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**worker_group** | **String** | the name of the worker group to restart | [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)
## restart_worker_pool
> String restart_worker_pool(worker_pool)
restart worker pool
Send a restart signal to all workers in the specified worker pool. Workers will gracefully shut down and are expected to be restarted by their supervisor. Requires devops role.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**worker_pool** | **String** | the name of the worker pool to restart | [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)
## revalidate_license
> models::RevalidateLicense200Response revalidate_license()
force an immediate licence revalidation
Revalidates the licence now instead of waiting for the periodic poll. Superadmin only. Never errors on a failed validation — the escalation ladder owns what failure means, so the resolved state is reported instead. `recovered` is true when this call cleared an existing failure (and therefore lifted read-only).
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::RevalidateLicense200Response**](revalidateLicense_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_log_cleanup
> String run_log_cleanup()
start a manual cleanup of expired logs from object storage
### Parameters
This endpoint does not need any parameter.
### 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)
## save_saml_config
> models::SamlConfig save_saml_config(saml_config_request)
save SAML SSO configuration
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**saml_config_request** | [**SamlConfigRequest**](SamlConfigRequest.md) | SAML configuration | [required] |
### Return type
[**models::SamlConfig**](SamlConfig.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)
## send_stats
> String send_stats()
send stats
### Parameters
This endpoint does not need any parameter.
### 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)
## set_global
> String set_global(key, set_global_request)
post global settings
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**key** | **String** | | [required] |
**set_global_request** | [**SetGlobalRequest**](SetGlobalRequest.md) | value set | [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_instance_config
> String set_instance_config(instance_config)
update instance config (bulk upsert, no deletes). Empty or missing global_settings/worker_configs are skipped.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**instance_config** | [**InstanceConfig**](InstanceConfig.md) | full instance configuration to apply | [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)
## setup_custom_instance_db
> models::CustomInstanceDb setup_custom_instance_db(name, setup_custom_instance_db_request)
Runs CREATE DATABASE on the Orvanta Postgres and grants access to the custom_instance_user
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | The name of the database to create | [required] |
**setup_custom_instance_db_request** | [**SetupCustomInstanceDbRequest**](SetupCustomInstanceDbRequest.md) | | [required] |
### Return type
[**models::CustomInstanceDb**](CustomInstanceDb.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)
## test_aws_sm_backend
> String test_aws_sm_backend(aws_secrets_manager_settings)
test connection to AWS Secrets Manager
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**aws_secrets_manager_settings** | [**AwsSecretsManagerSettings**](AwsSecretsManagerSettings.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_azure_kv_backend
> String test_azure_kv_backend(azure_key_vault_settings)
test Azure Key Vault connection
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**azure_key_vault_settings** | [**AzureKeyVaultSettings**](AzureKeyVaultSettings.md) | Azure Key Vault settings to test | [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_critical_channels
> String test_critical_channels(test_critical_channels_request_inner)
test critical channels
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**test_critical_channels_request_inner** | [**Vec<models::TestCriticalChannelsRequestInner>**](testCriticalChannels_request_inner.md) | test critical channel payload | [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_license_key
> String test_license_key(test_license_key_request)
test license key
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**test_license_key_request** | [**TestLicenseKeyRequest**](TestLicenseKeyRequest.md) | test license 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)
## test_metadata
> String test_metadata(body)
test metadata
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**body** | **String** | test metadata | [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_object_storage_config
> String test_object_storage_config(request_body)
test object storage config
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**request_body** | [**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md) | test object storage config | [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_secret_backend
> String test_secret_backend(vault_settings)
test secret backend connection (HashiCorp Vault)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**vault_settings** | [**VaultSettings**](VaultSettings.md) | Vault settings to test | [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_smtp
> String test_smtp(test_smtp_request)
test smtp
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**test_smtp_request** | [**TestSmtpRequest**](TestSmtpRequest.md) | test smtp payload | [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_saml_metadata
> models::SamlConfig update_saml_metadata()
refresh SAML IdP metadata from the configured idp_metadata_url
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::SamlConfig**](SamlConfig.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)
## workspace_acknowledge_all_critical_alerts
> String workspace_acknowledge_all_critical_alerts(workspace)
Acknowledge all unacknowledged critical alerts for this 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**: 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)
## workspace_acknowledge_critical_alert
> String workspace_acknowledge_critical_alert(workspace, id)
Acknowledge a critical alert for this workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**id** | **i32** | The ID of the critical alert to acknowledge | [required] |
### Return type
**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)
## workspace_get_critical_alerts
> models::GetCriticalAlerts200Response workspace_get_critical_alerts(workspace, page, page_size, acknowledged)
Get all critical alerts for this workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**page** | Option<**i32**> | | |[default to 1]
**page_size** | Option<**i32**> | | |[default to 10]
**acknowledged** | Option<**bool**> | | |
### Return type
[**models::GetCriticalAlerts200Response**](getCriticalAlerts_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)
## workspace_mute_critical_alerts_ui
> String workspace_mute_critical_alerts_ui(workspace, workspace_mute_critical_alerts_ui_request)
Mute critical alert UI for this workspace
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** | | [required] |
**workspace_mute_critical_alerts_ui_request** | [**WorkspaceMuteCriticalAlertsUiRequest**](WorkspaceMuteCriticalAlertsUiRequest.md) | Boolean flag to mute critical alerts. | [required] |
### Return type
**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)