# \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
[**create_customer_portal_session**](SettingApi.md#create_customer_portal_session) | **POST** /settings/customer_portal | create customer portal session
[**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_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 (EE only)
[**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
[**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
[**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
[**run_log_cleanup**](SettingApi.md#run_log_cleanup) | **POST** /settings/run_log_cleanup | start a manual cleanup of expired logs from object storage
[**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.
[**set_public_app_rate_limit**](SettingApi.md#set_public_app_rate_limit) | **POST** /w/{workspace}/workspaces/public_app_rate_limit | Set public app rate limit for this workspace
[**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
[**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)


## create_customer_portal_session

> String create_customer_portal_session(license_key)
create customer portal session

### 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)


## 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_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 (EE only)

### 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)


## 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)


## 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)


## 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.

### 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)


## 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)


## 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)


## set_public_app_rate_limit

> String set_public_app_rate_limit(workspace, set_public_app_rate_limit_request)
Set public app rate limit for this workspace

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**set_public_app_rate_limit_request** | [**SetPublicAppRateLimitRequest**](SetPublicAppRateLimitRequest.md) | Public app rate limit configuration | [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)


## 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)


## 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)

