v13

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-04237161688.6 KB
Instance Settings

Update instance settings

Updates the settings of an instance

patch/instance

Request body

test_modeboolean nullable

Toggles test mode for this instance, allowing the use of test email addresses and phone numbers. Defaults to true for development instances.

hibpboolean nullable

Whether the instance should be using the HIBP service to check passwords for breaches

support_emailstring nullable
clerk_js_versionstring nullable
development_originstring nullable
allowed_originsstring[]

For browser-like stacks such as browser extensions, Electron (not officially supported), or Capacitor.js (not officially supported), the instance allowed origins need to be updated with the request origin value. For Chrome extensions popup, background, or service worker pages, the origin is chrome-extension://extension_uuid. For Electron apps the default origin is http://localhost:3000. For Capacitor, the origin is capacitor://localhost.

cookieless_devboolean nullable

Whether the instance should operate in cookieless development mode (i.e. without third-party cookies). Deprecated: Please use url_based_session_syncing instead.

url_based_session_syncingboolean nullable

Whether the instance should use URL-based session syncing in development mode (i.e. without third-party cookies).

preferred_sign_in_strategy_when_password_required'password' | 'otp' | '' nullable

When password is required at the instance level, sets the preferred sign-in strategy surfaced to Clerk components. Has no effect when password is not required. Defaults to password. Set to an empty string to clear the override.

Response

Accepted