---
title: "Get Configuration"
method: GET
path: "/connect/config/"
tags: ["Config"]
---

# Get Configuration

`GET /connect/config/`

Retrieves the full set of configuration settings and associated metadata.
This response can be very large, particularly when the advanced parameter is set to 'true'.

## Query parameters

- `advanced` boolean

## Response `200`

The configuration setting objects

- ModelSetting[]
  - `advanced` boolean — (metadata) Indicates whether this setting should only be shown when the 'Show advanced settings' option is enabled in the user interface.
  - `default` string — (metadata) The default value for this configuration setting, if available
  - `defaultAvailable` boolean — (metadata) Indicates whether there is a default value available for this configuration setting
  - `description` string — (metadata) A description explaining the purpose of the configuration setting, if one is available.
  - `duplicates` boolean — (metadata) Indicates whether this setting can be duplicated. Duplicating settings is a complex area that can lead to system or upgrade failures so this is used sparingly.
  - `file` boolean — (metadata) Indicates whether the ID of this setting refers to a file on disk, in which case the changing the setting's value will replace the contents of the file on disk.
  - `forcedType` string — (metadata) The type that the value will be converted to internally before applied to the component that uses it.
  - `global` boolean — (metadata) Indicates whether this setting only applies to the grid as a whole
  - `helpLink` string — (metadata) An HTML page, relative to the doc URL, that may assist the user in understanding the purpose of this setting.
  - `id` string — The ID of the configuration setting. Each period represents a nested level.
  - `jinjaEscaped` boolean — (metadata) Indicates whether the setting value allows Jinja2 escape characters. By default these are prohibited as a security precaution.
  - `multiline` boolean — (metadata) Indicates whether this setting's user interface display should allow the user to enter values onto multiple lines
  - `node` boolean — (metadata) Indicates whether this setting can be applied differently per each node in the grid
  - `nodeId` string — The node ID to which this setting's value applies
  - `optionSeparator` string — (metadata) For multi-select options, the separator string used to store them into a single string
  - `options` string[] — (metadata) List of static values for a setting
  - `readonly` boolean — (metadata) Indicates whether this setting is read-only. Read-only settings should not be modified.
  - `readonlyUi` boolean — (metadata) Indicates whether this setting is read-only in the user interface only, but may be adjusted by the system itself.
  - `regex` string — (metadata) An optional regular expression pattern that the value of this setting must match
  - `regexFailureMessage` string — (metadata) The failure message to show on the user interface when the user enters a value that fails to match the regex.
  - `required` boolean — (metadata) If true this UI element must be specified by the user before it can be saved
  - `sensitive` boolean — (metadata) Indicates whether this setting's value should be masked in the user interface to prevent obtaining the existing value, while still permitting new values to be applied.
  - `syntax` string — (metadata) An optional syntax designator for validating the given setting value.
  - `title` string — (metadata) The configuration setting more human-friendly title, if one is available.
  - `uiElements` ModelUiElement[] — (metadata) List of UiElement objects describing how the UI should present the field for input
    - `default` unknown
    - `field` string — (metadata) The field name to save this value as
    - `forcedType` string — (metadata) The type that the value will be converted to internally before applied to the component that uses it.
    - `label` string — (metadata) The label to show on the UI
    - `multiline` boolean — (metadata) Indicates whether this setting's user interface display should allow the user to enter values onto multiple lines
    - `optionSeparator` string — (metadata) For multi-select options, the separator string used to store them into a single string
    - `options` string[] — (metadata) List of static values for a setting
    - `readonly` boolean — (metadata) If true this value cannot be changed after creation
    - `regex` string — (metadata) An optional regular expression pattern that the value of this setting must match
    - `regexFailureMessage` string — (metadata) The failure message to show on the user interface when the user enters a value that fails to match the regex.
    - `required` boolean — (metadata) If true this UI element must be specified by the user before it can be saved
  - `uiElementsDeleteMessage` string — (metadata) Confirmation message to show when user clicks the delete button on a ui element. If omitted, no message will be shown.
  - `value` string — The value of this specific configuration setting. Note that a setting exist multiple times if different values are applied to specific nodes

## Other responses

- `401` — Request was not properly authenticated
- `403` — Insufficient permissions for this request
- `405` — Configuration module has not been loaded
- `500` — Internal SOC error; review SOC logs

---

[API](https://skmtc.net/security-onion-solutions/apis/security-onion-connect-api.md) · [All operations](https://skmtc.net/security-onion-solutions/apis/security-onion-connect-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/security-onion-solutions/security-onion-connect-api/revisions/0576ce393f8d/schema)