Skip to main content Module setting_api Copy item path Source 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 DeleteSamlConfigError struct for typed errors of method delete_saml_config 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 GetRuntimeUsageError struct for typed errors of method get_runtime_usage GetRuntimeUsageLocationsError struct for typed errors of method get_runtime_usage_locations GetSamlConfigError struct for typed errors of method get_saml_config GetSamlSpMetadataError struct for typed errors of method get_saml_sp_metadata GetSecondaryStorageNamesError struct for typed errors of method get_secondary_storage_names GetStatsError struct for typed errors of method get_stats InitiateSamlLoginError struct for typed errors of method initiate_saml_login InitiateSamlLoginGetError struct for typed errors of method initiate_saml_login_get 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 RestartWorkerPoolError struct for typed errors of method restart_worker_pool RevalidateLicenseError struct for typed errors of method revalidate_license RunLogCleanupError struct for typed errors of method run_log_cleanup SaveSamlConfigError struct for typed errors of method save_saml_config 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 UpdateSamlMetadataError struct for typed errors of method update_saml_metadata 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 acknowledge_all_critical_alerts acknowledge_critical_alert compute_object_storage_usage create_customer_portal_session delete_saml_config 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_runtime_usage Powers the Runtimes admin page (#190/#255 runtime governance) — for each language currently in use anywhere on the instance, how many scripts, flows, and apps use it. A language with no usage is simply absent from the response. get_runtime_usage_locations 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. get_saml_config get_saml_sp_metadata get_secondary_storage_names get_stats initiate_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. initiate_saml_login_get 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. Deprecated (#370): use POST /settings/restart_worker_pool/{worker_pool} instead. 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. revalidate_license 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). run_log_cleanup save_saml_config 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 update_saml_metadata workspace_acknowledge_all_critical_alerts workspace_acknowledge_critical_alert workspace_get_critical_alerts workspace_mute_critical_alerts_ui