settings

El dominio settings tiene 5 acciones. En la superficie meta se alcanzan todas a través de arcane_settings; en la individual, cada una es una herramienta propia; en la dinámica se ejecutan con arcane_execute_action y el ID canónico.

Resumen

Acción	Título	Tipo
settings.categories	Get settings categories	lectura
settings.get	Get settings	lectura
settings.public	Get public settings	lectura
settings.search	Search settings	lectura
settings.update	Update settings	escritura

Acciones

settings.categories

Get settings categories

Get all available settings categories with metadata

• Tipo: lectura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_settings con "action": "categories"
• Herramienta individual: arcane_settings_categories
• Ruta de Arcane: GET /api/settings/categories
• ID de operación: get-settings-categories
• Uso: Every settings category the caller may access (id, title, description, url) with the metadata (key, label, type, description) of the settings in it. Use it to browse all keys, settings.search to find one by word. Returns no values: settings.get does.
• Acciones relacionadas: settings.search, settings.get

settings.get

Get settings

Get all settings for an environment

• Tipo: lectura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_settings con "action": "get"
• Herramienta individual: arcane_settings_get
• Ruta de Arcane: GET /api/environments/{id}/settings
• ID de operación: get-settings
• Uso: Current values of one environment’s settings as {key, type, value} items, every value a string (environmentId “0” is the local manager, others come from environment.list, and a remote environment answers with its agent’s own settings). Needs the settings:read permission. Non-admins get a reduced set, secrets such as oidcClientSecret, depotToken and trivyServerToken read back as “XXXXXXXXXX”, and the local answer adds read-only runtime keys (uiConfigDisabled, depotConfigured, …). Find a key by topic with settings.search.
• Acciones relacionadas: settings.update, settings.search, settings.public, environment.list

settings.public

Get public settings

Get all public settings for an environment

• Tipo: lectura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_settings con "action": "public"
• Herramienta individual: arcane_settings_public
• Ruta de Arcane: GET /api/environments/{id}/settings/public
• ID de operación: get-public-settings
• Uso: The settings Arcane exposes without authentication (authLocalEnabled, oidcEnabled and the OIDC provider name/logo/auto-redirect, featureSwarmEnabled, featureVulnerabilityManagementEnabled, branding and telemetry flags) as {key, type, value} items, never secrets. For a remote environmentId the agent’s public settings are returned. Use settings.get for the full configuration when logged in.
• Acciones relacionadas: settings.get, oidc.status

settings.search

Search settings

Search settings categories and individual settings by query

• Tipo: lectura
• Parámetros obligatorios: query
• Meta-herramienta: arcane_settings con "action": "search"
• Herramienta individual: arcane_settings_search
• Ruta de Arcane: POST /api/settings/search
• ID de operación: search-settings
• Uso: Finds the settings categories and keys matching a non-empty query (e.g. gravatar) when you do not know a key’s name. Each result category carries matchingSettings with key, label and type, plus a relevanceScore. Not environment-scoped, limited to the categories the caller may access, and returns no values: read them with settings.get.
• Acciones relacionadas: settings.get, settings.categories, settings.update

settings.update

Update settings

Update settings for an environment

• Tipo: escritura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_settings con "action": "update"
• Herramienta individual: arcane_settings_update
• Ruta de Arcane: PUT /api/environments/{id}/settings
• ID de operación: update-settings
• Uso: Changes only the keys given, each as a string (e.g. {“avatarMaxUploadSizeMb”: “7”}, booleans as “true”/“false”). An empty string resets most keys to their default (an empty depotToken or trivyServerToken is ignored), a remote environment’s agent applies the change to itself, and effects of some keys (e.g. apnsEnabled registering a push channel) finish asynchronously after the answer. Needs settings:write. Authentication and OIDC keys are accepted only on environment “0” (403 elsewhere), enabling OIDC requires oidcClientId, oidcClientSecret and oidcIssuerUrl, changing oidcIssuerUrl (or trivyServerUrl) while a client secret (or server token) is stored requires resending it in the same call, avatarMaxUploadSizeMb must be 1-50, projectsDirectory and swarmStackSourcesDirectory absolute paths, and trivyConfig a YAML mapping. Never send back the “XXXXXXXXXX” mask settings.get shows for a secret, because it would be stored as the new value. The result lists only the non-admin-visible keys (all typed “string”), so verify other keys with settings.get.
• Acciones relacionadas: settings.get, settings.search, container.set_auto_update