> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/open-webui/open-webui/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Configuration

> Export the complete system configuration

Exports the complete system configuration including all settings, OAuth providers, tool servers, models, and UI preferences.

## Authentication

Requires admin authentication.

## Response

<ResponseField name="version" type="integer">
  Configuration version number
</ResponseField>

<ResponseField name="ui" type="object">
  UI-related configuration settings

  <Expandable title="properties">
    <ResponseField name="enable_signup" type="boolean">
      Whether user signup is enabled
    </ResponseField>

    <ResponseField name="ENABLE_LOGIN_FORM" type="boolean">
      Whether login form is displayed
    </ResponseField>

    <ResponseField name="default_locale" type="string">
      Default locale for the UI
    </ResponseField>

    <ResponseField name="default_models" type="string">
      Comma-separated list of default models
    </ResponseField>

    <ResponseField name="default_pinned_models" type="string">
      Comma-separated list of pinned models
    </ResponseField>

    <ResponseField name="model_order_list" type="array">
      Ordered list of model IDs
    </ResponseField>

    <ResponseField name="prompt_suggestions" type="array">
      Array of prompt suggestion objects

      <Expandable title="properties">
        <ResponseField name="title" type="array">
          Array of title strings
        </ResponseField>

        <ResponseField name="content" type="string">
          The prompt content
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="default_user_role" type="string">
      Default role for new users (e.g., "pending", "user")
    </ResponseField>

    <ResponseField name="default_group_id" type="string">
      Default group ID for new users
    </ResponseField>

    <ResponseField name="watermark" type="string">
      Response watermark text
    </ResponseField>

    <ResponseField name="enable_community_sharing" type="boolean">
      Whether community sharing is enabled
    </ResponseField>

    <ResponseField name="enable_message_rating" type="boolean">
      Whether message rating is enabled
    </ResponseField>

    <ResponseField name="enable_user_webhooks" type="boolean">
      Whether user webhooks are enabled
    </ResponseField>

    <ResponseField name="banners" type="array">
      Array of banner objects

      <Expandable title="properties">
        <ResponseField name="id" type="string" required>
          Unique banner identifier
        </ResponseField>

        <ResponseField name="type" type="string" required>
          Banner type (e.g., "info", "warning", "error")
        </ResponseField>

        <ResponseField name="title" type="string">
          Banner title (optional)
        </ResponseField>

        <ResponseField name="content" type="string" required>
          Banner content
        </ResponseField>

        <ResponseField name="dismissible" type="boolean" required>
          Whether the banner can be dismissed
        </ResponseField>

        <ResponseField name="timestamp" type="integer" required>
          Unix timestamp when banner was created
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="auth" type="object">
  Authentication configuration

  <Expandable title="properties">
    <ResponseField name="enable_api_keys" type="boolean">
      Whether API keys are enabled
    </ResponseField>

    <ResponseField name="api_key.endpoint_restrictions" type="boolean">
      Whether API key endpoint restrictions are enabled
    </ResponseField>

    <ResponseField name="api_key.allowed_endpoints" type="string">
      Comma-separated list of allowed endpoints for API keys
    </ResponseField>

    <ResponseField name="jwt_expiry" type="string">
      JWT expiration time (e.g., "4w", "30d")
    </ResponseField>

    <ResponseField name="admin.show" type="boolean">
      Whether to show admin details
    </ResponseField>

    <ResponseField name="admin.email" type="string">
      Admin email address
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="oauth" type="object">
  OAuth configuration settings

  <Expandable title="properties">
    <ResponseField name="enable_signup" type="boolean">
      Whether OAuth signup is enabled
    </ResponseField>

    <ResponseField name="merge_accounts_by_email" type="boolean">
      Whether to merge accounts by email
    </ResponseField>

    <ResponseField name="enable_role_mapping" type="boolean">
      Whether OAuth role mapping is enabled
    </ResponseField>

    <ResponseField name="enable_group_mapping" type="boolean">
      Whether OAuth group mapping is enabled
    </ResponseField>

    <ResponseField name="enable_group_creation" type="boolean">
      Whether OAuth group creation is enabled
    </ResponseField>

    <ResponseField name="allowed_domains" type="array">
      Array of allowed domains for OAuth
    </ResponseField>

    <ResponseField name="update_picture_on_login" type="boolean">
      Whether to update user picture on login
    </ResponseField>

    <ResponseField name="update_name_on_login" type="boolean">
      Whether to update user name on login
    </ResponseField>

    <ResponseField name="update_email_on_login" type="boolean">
      Whether to update user email on login
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="ollama" type="object">
  Ollama configuration

  <Expandable title="properties">
    <ResponseField name="enable" type="boolean">
      Whether Ollama API is enabled
    </ResponseField>

    <ResponseField name="base_urls" type="array">
      Array of Ollama base URLs
    </ResponseField>

    <ResponseField name="api_configs" type="object">
      Per-URL API configurations
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="openai" type="object">
  OpenAI configuration

  <Expandable title="properties">
    <ResponseField name="enable" type="boolean">
      Whether OpenAI API is enabled
    </ResponseField>

    <ResponseField name="api_keys" type="array">
      Array of OpenAI API keys
    </ResponseField>

    <ResponseField name="api_base_urls" type="array">
      Array of OpenAI API base URLs
    </ResponseField>

    <ResponseField name="api_configs" type="object">
      Per-URL API configurations
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="models" type="object">
  Model configuration

  <Expandable title="properties">
    <ResponseField name="base_models_cache" type="boolean">
      Whether base models cache is enabled
    </ResponseField>

    <ResponseField name="default_metadata" type="object">
      Default metadata for models
    </ResponseField>

    <ResponseField name="default_params" type="object">
      Default parameters for models
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="tool_server" type="object">
  Tool server configuration

  <Expandable title="properties">
    <ResponseField name="connections" type="array">
      Array of tool server connection objects

      <Expandable title="properties">
        <ResponseField name="url" type="string" required>
          Tool server URL
        </ResponseField>

        <ResponseField name="path" type="string" required>
          Path to OpenAPI spec
        </ResponseField>

        <ResponseField name="type" type="string">
          Connection type ("openapi" or "mcp")
        </ResponseField>

        <ResponseField name="auth_type" type="string">
          Authentication type ("bearer", "session", "oauth\_2.1", etc.)
        </ResponseField>

        <ResponseField name="headers" type="object">
          Custom headers
        </ResponseField>

        <ResponseField name="key" type="string">
          API key or token
        </ResponseField>

        <ResponseField name="config" type="object">
          Additional configuration
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="terminal_server" type="object">
  Terminal server configuration

  <Expandable title="properties">
    <ResponseField name="connections" type="array">
      Array of terminal server connection objects
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="direct" type="object">
  Direct connection settings

  <Expandable title="properties">
    <ResponseField name="enable" type="boolean">
      Whether direct connections are enabled
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="webui" type="object">
  Web UI configuration

  <Expandable title="properties">
    <ResponseField name="url" type="string">
      Web UI URL
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="user" type="object">
  User configuration

  <Expandable title="properties">
    <ResponseField name="permissions" type="object">
      Default user permissions object with nested workspace, sharing, chat, features, and settings permissions
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="folders" type="object">
  Folder configuration

  <Expandable title="properties">
    <ResponseField name="enable" type="boolean">
      Whether folders are enabled
    </ResponseField>

    <ResponseField name="max_file_count" type="string">
      Maximum file count per folder
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="channels" type="object">
  Channel configuration

  <Expandable title="properties">
    <ResponseField name="enable" type="boolean">
      Whether channels are enabled
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="notes" type="object">
  Notes configuration

  <Expandable title="properties">
    <ResponseField name="enable" type="boolean">
      Whether notes are enabled
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="webhook_url" type="string">
  Webhook URL for notifications
</ResponseField>

## Example Response

```json theme={null}
{
  "version": 0,
  "ui": {
    "enable_signup": true,
    "ENABLE_LOGIN_FORM": true,
    "default_locale": "",
    "default_models": null,
    "default_pinned_models": null,
    "model_order_list": [],
    "prompt_suggestions": [
      {
        "title": ["Help me study", "vocabulary for a college entrance exam"],
        "content": "Help me study vocabulary: write a sentence for me to fill in the blank, and I'll try to pick the correct option."
      }
    ],
    "default_user_role": "pending",
    "default_group_id": "",
    "watermark": "",
    "enable_community_sharing": true,
    "enable_message_rating": true,
    "enable_user_webhooks": true,
    "banners": []
  },
  "auth": {
    "enable_api_keys": false,
    "api_key": {
      "endpoint_restrictions": false,
      "allowed_endpoints": ""
    },
    "jwt_expiry": "4w",
    "admin": {
      "show": true,
      "email": null
    }
  },
  "ollama": {
    "enable": true,
    "base_urls": ["http://localhost:11434"],
    "api_configs": {}
  },
  "openai": {
    "enable": true,
    "api_keys": [],
    "api_base_urls": ["https://api.openai.com/v1"],
    "api_configs": {}
  },
  "models": {
    "base_models_cache": false,
    "default_metadata": {},
    "default_params": {}
  },
  "tool_server": {
    "connections": []
  },
  "direct": {
    "enable": false
  },
  "webui": {
    "url": ""
  }
}
```