settings

The settings domain has 5 actions. On the meta surface they are all reached through arcane_settings; on the individual surface each one is its own tool; on the dynamic surface run them with arcane_execute_action and the canonical ID.

Summary

Action	Title	Kind
settings.categories	Get settings categories	read
settings.get	Get settings	read
settings.public	Get public settings	read
settings.search	Search settings	read
settings.update	Update settings	write

Actions

settings.categories

Get settings categories

Get all available settings categories with metadata

• Kind: read
• Required parameters: none
• Meta tool: arcane_settings with "action": "categories"
• Individual tool: arcane_settings_categories
• Arcane route: GET /api/settings/categories
• Operation ID: get-settings-categories
• Usage: 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.
• Related actions: settings.search, settings.get

settings.get

Get settings

Get all settings for an environment

• Kind: read
• Required parameters: none
• Meta tool: arcane_settings with "action": "get"
• Individual tool: arcane_settings_get
• Arcane route: GET /api/environments/{id}/settings
• Operation ID: get-settings
• Usage: 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.
• Related actions: settings.update, settings.search, settings.public, environment.list

settings.public

Get public settings

Get all public settings for an environment

• Kind: read
• Required parameters: none
• Meta tool: arcane_settings with "action": "public"
• Individual tool: arcane_settings_public
• Arcane route: GET /api/environments/{id}/settings/public
• Operation ID: get-public-settings
• Usage: 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.
• Related actions: settings.get, oidc.status

settings.search

Search settings

Search settings categories and individual settings by query

• Kind: read
• Required parameters: query
• Meta tool: arcane_settings with "action": "search"
• Individual tool: arcane_settings_search
• Arcane route: POST /api/settings/search
• Operation ID: search-settings
• Usage: 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.
• Related actions: settings.get, settings.categories, settings.update

settings.update

Update settings

Update settings for an environment

• Kind: write
• Required parameters: none
• Meta tool: arcane_settings with "action": "update"
• Individual tool: arcane_settings_update
• Arcane route: PUT /api/environments/{id}/settings
• Operation ID: update-settings
• Usage: 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.
• Related actions: settings.get, settings.search, container.set_auto_update