Sign in
Config Ops

Import Configuration

Import configuration in merge or overwrite mode.

Merge mode: updates existing settings and OAuth providers, adds new ones. Overwrite mode: replaces all settings and OAuth providers.

post/config-ops/import/

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'

Headers

X-Config-Preview-Tokenstring nullable

Signed token returned by the matching dry-run. Required for overwrite mode and for a merge that would delete the stored embeddings.

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

settings_appliedinteger required

Number of settings successfully updated.

settings_skippedinteger required

Number of settings skipped (no change, unknown key, or restricted key not writable by the current runtime).

settings_skipped_restrictedstring[]

Names of restricted setting keys that were skipped by the current runtime.

oauth_createdinteger required

Number of new OAuth providers created.

oauth_updatedinteger required

Number of existing OAuth providers updated.

oauth_deletedinteger required

Number of OAuth providers deleted (overwrite mode only).

oauth_accounts_deletedinteger

Number of dependent OAuth account links cascade-deleted in overwrite mode.

Changes

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