Skip to main content

Module setting_api

Module setting_api 

Source

Enums§

AcknowledgeAllCriticalAlertsError
struct for typed errors of method acknowledge_all_critical_alerts
AcknowledgeCriticalAlertError
struct for typed errors of method acknowledge_critical_alert
ComputeObjectStorageUsageError
struct for typed errors of method compute_object_storage_usage
CreateCustomerPortalSessionError
struct for typed errors of method create_customer_portal_session
DropCustomInstanceDbError
struct for typed errors of method drop_custom_instance_db
GetCriticalAlertsError
struct for typed errors of method get_critical_alerts
GetGlobalError
struct for typed errors of method get_global
GetInstanceConfigError
struct for typed errors of method get_instance_config
GetJwksError
struct for typed errors of method get_jwks
GetLatestKeyRenewalAttemptError
struct for typed errors of method get_latest_key_renewal_attempt
GetLocalError
struct for typed errors of method get_local
GetLogCleanupStatusError
struct for typed errors of method get_log_cleanup_status
GetMinKeepAliveVersionError
struct for typed errors of method get_min_keep_alive_version
GetObjectStorageUsageError
struct for typed errors of method get_object_storage_usage
GetRuffConfigError
struct for typed errors of method get_ruff_config
GetSecondaryStorageNamesError
struct for typed errors of method get_secondary_storage_names
GetStatsError
struct for typed errors of method get_stats
ListCustomInstanceDbsError
struct for typed errors of method list_custom_instance_dbs
ListGlobalSettingsError
struct for typed errors of method list_global_settings
MigrateSecretsFromAwsSmError
struct for typed errors of method migrate_secrets_from_aws_sm
MigrateSecretsFromAzureKvError
struct for typed errors of method migrate_secrets_from_azure_kv
MigrateSecretsToAwsSmError
struct for typed errors of method migrate_secrets_to_aws_sm
MigrateSecretsToAzureKvError
struct for typed errors of method migrate_secrets_to_azure_kv
MigrateSecretsToDatabaseError
struct for typed errors of method migrate_secrets_to_database
MigrateSecretsToVaultError
struct for typed errors of method migrate_secrets_to_vault
RefreshCustomInstanceUserPwdError
struct for typed errors of method refresh_custom_instance_user_pwd
RenewLicenseKeyError
struct for typed errors of method renew_license_key
RestartWorkerGroupError
struct for typed errors of method restart_worker_group
RunLogCleanupError
struct for typed errors of method run_log_cleanup
SendStatsError
struct for typed errors of method send_stats
SetGlobalError
struct for typed errors of method set_global
SetInstanceConfigError
struct for typed errors of method set_instance_config
SetPublicAppRateLimitError
struct for typed errors of method set_public_app_rate_limit
SetupCustomInstanceDbError
struct for typed errors of method setup_custom_instance_db
TestAwsSmBackendError
struct for typed errors of method test_aws_sm_backend
TestAzureKvBackendError
struct for typed errors of method test_azure_kv_backend
TestCriticalChannelsError
struct for typed errors of method test_critical_channels
TestLicenseKeyError
struct for typed errors of method test_license_key
TestMetadataError
struct for typed errors of method test_metadata
TestObjectStorageConfigError
struct for typed errors of method test_object_storage_config
TestSecretBackendError
struct for typed errors of method test_secret_backend
TestSmtpError
struct for typed errors of method test_smtp
WorkspaceAcknowledgeAllCriticalAlertsError
struct for typed errors of method workspace_acknowledge_all_critical_alerts
WorkspaceAcknowledgeCriticalAlertError
struct for typed errors of method workspace_acknowledge_critical_alert
WorkspaceGetCriticalAlertsError
struct for typed errors of method workspace_get_critical_alerts
WorkspaceMuteCriticalAlertsUiError
struct for typed errors of method workspace_mute_critical_alerts_ui

Functions§

acknowledge_all_critical_alerts
acknowledge_critical_alert
compute_object_storage_usage
create_customer_portal_session
drop_custom_instance_db
get_critical_alerts
get_global
get_instance_config
get_jwks
get_latest_key_renewal_attempt
get_local
get_log_cleanup_status
get_min_keep_alive_version
get_object_storage_usage
get_ruff_config
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.
get_secondary_storage_names
get_stats
list_custom_instance_dbs
list_global_settings
migrate_secrets_from_aws_sm
migrate_secrets_from_azure_kv
migrate_secrets_to_aws_sm
migrate_secrets_to_azure_kv
migrate_secrets_to_database
migrate_secrets_to_vault
refresh_custom_instance_user_pwd
renew_license_key
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.
run_log_cleanup
send_stats
set_global
set_instance_config
set_public_app_rate_limit
setup_custom_instance_db
test_aws_sm_backend
test_azure_kv_backend
test_critical_channels
test_license_key
test_metadata
test_object_storage_config
test_secret_backend
test_smtp
workspace_acknowledge_all_critical_alerts
workspace_acknowledge_critical_alert
workspace_get_critical_alerts
workspace_mute_critical_alerts_ui