POST /setting/get
Get Setting
Get setting information using the canonical shared setting operation.
Request Body (GetSettingApiRequest)
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | UUID of the setting to retrieve |
setting_id | string | No | Legacy setting identifier |
settings_id | string | No | Legacy alias for setting identifier |
draft_id | string | No | UUID of the draft to load |
snapshot_key | string | No | Cache snapshot key for consistent reads across related requests |
names | app__infra__setting__types__SectionFilter | No | Filter options for names |
descriptions | app__infra__setting__types__SectionFilter | No | Filter options for descriptions |
colors | app__infra__setting__types__SectionFilter | No | Filter options for colors |
flags | app__infra__setting__types__SectionFilter | No | Filter options for flags |
departments | app__infra__setting__types__SectionFilter | No | Filter options for departments |
logins | app__infra__setting__types__SectionFilter | No | Filter options for logins |
systems | app__infra__setting__types__SectionFilter | No | Filter options for systems |
mcp | app__infra__setting__types__SectionFilter | No | Filter options for MCP configs |
thresholds | app__infra__setting__types__SectionFilter | No | Filter options for thresholds |
provider_keys | app__infra__setting__types__SectionFilter | No | Filter options for provider keys |
auth_item_keys | app__infra__setting__types__SectionFilter | No | Filter options for auth item keys |
auth_item_values | app__infra__setting__types__SectionFilter | No | Filter options for auth item values |
Response (GetSettingApiResponse)
| Field | Type | Required | Description |
|---|---|---|---|
actor_name | string | No | Display name of the acting user |
setting_exists | boolean | No | Whether the setting exists |
can_edit | boolean | No | Whether the actor can edit this setting |
disabled_reason | string | No | Reason editing is disabled, if any |
group_id | string | No | Group UUID for draft collaboration |
draft_name | string | No | Immutable draft label from the active draft entry, when a draft_id was supplied. None for non-draft fetches. |
show_ai_generate | boolean | No | Whether any section should show AI generate |
basic_show_ai_generate | boolean | No | Whether the basic section should show AI generate |
pending_ids | string[] | No | Pending resource identifiers when available |
names | SettingNameResource[] | No | Name resources |
descriptions | SettingDescriptionResource[] | No | Description resources |
colors | SettingColorResource[] | No | Color resources |
flags | SettingFlagResource[] | No | Flag resources (one per flags_resource row, value=true/false) |
departments | SettingDepartmentResource[] | No | Department resources |
logins | SettingLoginsResource[] | No | Logins resources |
systems | SettingSystemResource[] | No | System resources |
mcp | SettingMcpResource[] | No | MCP resources |
thresholds | SettingThresholdResource[] | No | Threshold resources |
provider_keys | SettingProviderKeyResource[] | No | Provider key resources |
auth_item_keys | SettingAuthItemKeyResource[] | No | Auth item key resources |
auth_item_values | SettingAuthItemValueResource[] | No | Auth item value resources |
providers | SettingProviderCatalogResource[] | No | Provider catalog used by provider key editing |
keys | SettingKeyCatalogResource[] | No | Key catalog used by provider key and auth item key editing |
items | SettingItemCatalogResource[] | No | Claim item catalog used by auth item key/value editing |
profiles | SettingProfileCatalogResource[] | No | Profile catalog used by logins editing |
auths | SettingAuthCatalogResource[] | No | Auth catalog used by logins and auth item editing |
icons | SettingIconCatalogResource[] | No | Icon catalog used by logins editing |
agents | SettingAgentCatalogResource[] | No | Agent catalog used by mcp and systems editing |
provider_key_options | SettingProviderKeyOption[] | No | Curated (provider × key) options for the ProviderKeys picker |
auth_item_key_options | SettingAuthItemKeyOption[] | No | Curated (auth × key) options for the AuthItemKeys picker |
auth_item_value_options | SettingAuthItemValueOption[] | No | Curated (auth × item) options for the AuthItemValues picker |
mcp_options | SettingMcpOption[] | No | Curated per-agent options for the MCP picker |
login_options | SettingLoginOption[] | No | Curated (auth × profile) options for the Logins picker |
Last updated on