Sign in
Config Ops

Dry Run Configuration

Preview what an import would change without applying any modifications.

post/config-ops/dry-run/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Query parameters

mode'merge' | 'overwrite'

Request body

settingsobject nullable

Optional settings to import. Omit to import only OAuth providers.

oauth_providersobject[] nullable

Optional OAuth providers to import. Client secrets must be re-supplied via the admin UI after import.

Response

Successful Response

settingsobject required

Per-setting diff result keyed by setting name.

oauth_providersobject required

Per-provider diff result keyed by slug.

preview_tokenstring nullable

Short-lived signed confirmation token required to apply an overwrite, or a merge that would delete the stored embeddings. Bound to the normalized payload, mode, and current configuration state.

Changes

No recorded changes to this operation across all 50 revisions of this API.