Cfg API
The cfg surface is the runtime configuration store: feature flags, settings, role / permission edits, translations, LLM profiles, controlled vocabularies, menu items, macros, and search parameter presets. All endpoints are admin-scoped. Mutations land in cfg_* tables; readers refresh via /admin/cfg/reload. A /snapshot endpoint exports the full effective config as a single JSON document.
| Method | Path | Summary | Key params | Response |
|---|---|---|---|---|
| GET | /admin/cfg/attribute-types | List attribute types | — | AttributeTypeDto[] |
| POST | /admin/cfg/attribute-types | Create attribute type | body: AttributeTypeCreate | CfgOkResponse |
| DELETE | /admin/cfg/attribute-types/{key} | Delete attribute type | key (path:string) | CfgOkResponse |
| GET | /admin/cfg/attribute-types/{key} | Get attribute type | key (path:string) | AttributeTypeDto |
| PUT | /admin/cfg/attribute-types/{key} | Update attribute type | key (path:string)body: AttributeTypeUpdate | CfgOkResponse |
| GET | /admin/cfg/dlu-types | List DLU types | — | DluTypeDto[] |
| POST | /admin/cfg/dlu-types | Create DLU type | body: DluTypeCreate | CfgOkResponse |
| DELETE | /admin/cfg/dlu-types/{key} | Delete DLU type | key (path:string) | CfgOkResponse |
| GET | /admin/cfg/dlu-types/{key} | Get DLU type | key (path:string) | DluTypeDto |
| PUT | /admin/cfg/dlu-types/{key} | Update DLU type | key (path:string)body: DluTypeUpdate | CfgOkResponse |
| GET | /admin/cfg/entity-types | List entity types | — | EntityTypeDto[] |
| POST | /admin/cfg/entity-types | Create entity type | body: EntityTypeCreate | CfgOkResponse |
| DELETE | /admin/cfg/entity-types/{key} | Delete entity type | key (path:string) | CfgOkResponse |
| GET | /admin/cfg/entity-types/{key} | Get entity type | key (path:string) | EntityTypeDto |
| PUT | /admin/cfg/entity-types/{key} | Update entity type | key (path:string)body: EntityTypeUpdate | CfgOkResponse |
| GET | /admin/cfg/feature-flags | List feature flags | — | FeatureFlagDto[] |
| POST | /admin/cfg/feature-flags | Create feature flag | body: FeatureFlagCreate | CfgOkResponse |
| DELETE | /admin/cfg/feature-flags/{key} | Delete feature flag | key (path:string) | CfgOkResponse |
| GET | /admin/cfg/feature-flags/{key} | Get feature flag | key (path:string) | FeatureFlagDto |
| PUT | /admin/cfg/feature-flags/{key} | Update feature flag | key (path:string)body: FeatureFlagUpdate | CfgOkResponse |
| GET | /admin/cfg/llm-profiles | List LLM profiles | — | LlmProfileDto[] |
| POST | /admin/cfg/llm-profiles | Create LLM profile | body: LlmProfileCreate | CfgOkResponse |
| DELETE | /admin/cfg/llm-profiles/{key} | Delete LLM profile | key (path:string) | CfgOkResponse |
| GET | /admin/cfg/llm-profiles/{key} | Get LLM profile | key (path:string) | LlmProfileDto |
| PUT | /admin/cfg/llm-profiles/{key} | Update LLM profile | key (path:string)body: LlmProfileUpdate | CfgOkResponse |
| GET | /admin/cfg/macros | List query macros | — | MacroDto[] |
| POST | /admin/cfg/macros | Create query macro | body: MacroCreate | CfgOkResponse |
| DELETE | /admin/cfg/macros/{key} | Delete query macro | key (path:string) | CfgOkResponse |
| GET | /admin/cfg/macros/{key} | Get query macro | key (path:string) | MacroDto |
| PUT | /admin/cfg/macros/{key} | Update query macro | key (path:string)body: MacroUpdate | CfgOkResponse |
| GET | /admin/cfg/menu-items | List menu items | — | MenuItemDto[] |
| POST | /admin/cfg/menu-items | Create menu item | body: MenuItemCreate | CfgOkResponse |
| DELETE | /admin/cfg/menu-items/{key} | Delete menu item | key (path:string) | CfgOkResponse |
| GET | /admin/cfg/menu-items/{key} | Get menu item | key (path:string) | MenuItemDto |
| PUT | /admin/cfg/menu-items/{key} | Update menu item | key (path:string)body: MenuItemUpdate | CfgOkResponse |
| GET | /admin/cfg/permissions | List permissions | — | PermissionDto[] |
| POST | /admin/cfg/permissions | Create permission | body: PermissionCreate | CfgOkResponse |
| DELETE | /admin/cfg/permissions/{key} | Delete permission | key (path:string) | CfgOkResponse |
| GET | /admin/cfg/permissions/{key} | Get permission | key (path:string) | PermissionDto |
| PUT | /admin/cfg/permissions/{key} | Update permission | key (path:string)body: PermissionUpdate | CfgOkResponse |
| GET | /admin/cfg/role-permissions | List role↔permission grants | — | RolePermissionDto[] |
| POST | /admin/cfg/role-permissions | Grant permission to role | body: RolePermissionGrant | CfgOkResponse |
| DELETE | /admin/cfg/role-permissions/{role}/{permission} | Revoke permission from role | role (path:string)permission (path:string) | CfgOkResponse |
| GET | /admin/cfg/roles | List roles | — | RoleDto[] |
| POST | /admin/cfg/roles | Create role | body: RoleCreate | CfgOkResponse |
| DELETE | /admin/cfg/roles/{key} | Delete role | key (path:string) | CfgOkResponse |
| GET | /admin/cfg/roles/{key} | Get role | key (path:string) | RoleDto |
| PUT | /admin/cfg/roles/{key} | Update role | key (path:string)body: RoleUpdate | CfgOkResponse |
| GET | /admin/cfg/search-params | List search params | — | SearchParamDto[] |
| POST | /admin/cfg/search-params | Create search param | body: SearchParamCreate | CfgOkResponse |
| DELETE | /admin/cfg/search-params/{key} | Delete search param | key (path:string) | CfgOkResponse |
| GET | /admin/cfg/search-params/{key} | Get search param | key (path:string) | SearchParamDto |
| PUT | /admin/cfg/search-params/{key} | Update search param | key (path:string)body: SearchParamUpdate | CfgOkResponse |
| GET | /admin/cfg/settings | List settings | — | SettingDto[] |
| POST | /admin/cfg/settings | Create setting | body: SettingCreate | CfgOkResponse |
| DELETE | /admin/cfg/settings/{key} | Delete setting | key (path:string) | CfgOkResponse |
| GET | /admin/cfg/settings/{key} | Get setting | key (path:string) | SettingDto |
| PUT | /admin/cfg/settings/{key} | Update setting | key (path:string)body: SettingUpdate | CfgOkResponse |
| GET | /admin/cfg/translations | List translations | — | TranslationListDto |
| POST | /admin/cfg/translations | Create translation | body: TranslationCreate | CfgOkResponse |
| DELETE | /admin/cfg/translations/{key} | Delete translation | key (path:string) | CfgOkResponse |
| GET | /admin/cfg/translations/{key} | Get translation | key (path:string) | TranslationDto |
| PUT | /admin/cfg/translations/{key} | Update translation | key (path:string)body: TranslationUpdate | CfgOkResponse |
| DELETE | /admin/llm-config | Reset the RAG system prompt to default | — | (no body) |
| GET | /admin/llm-config | Read the active RAG system prompt | — | LlmConfigResponse |
| PUT | /admin/llm-config | Replace the active RAG system prompt | body: PutLlmConfigRequest | (no body) |
Examples
Section titled “Examples”Snapshot the entire effective config
curl -H "X-API-Key: $API_KEY" "$ARCHAIC/admin/cfg/snapshot"Force in-process readers to reload from DB
curl -X POST -H "X-API-Key: $API_KEY" "$ARCHAIC/admin/cfg/reload"