Config

Create or update a config entry (reserved env-only keys are rejected). Global-scope writes auto-trigger an integrations reload (debounced ~250ms) so Slack/GitHub/Linear/Jira/AgentMail pick up new credentials without an explicit /api/config/reload call.

Changed on
put/api/config

Request

  • Base URL
    http://localhost:3013
  • URL
    http://localhost:3013/api/config
  • Auth
    HTTP bearer

Request body

scope'global' | 'agent' | 'repo' required
scopeIdstring nullable
keystring required
valueunknown
isSecretboolean
envPathstring nullable
descriptionstring nullable
exportToEnvboolean

Export this row into agent process env (default true on create, false for a few server-side secrets; omitted on update keeps the stored flag). Rejected as true for keys only the API server reads.

Response

Config entry upserted

idstring uuid required
scope'global' | 'agent' | 'repo' required
scopeIdstring nullable required
keystring required
valuestring required
isSecretboolean required
envPathstring nullable required
descriptionstring nullable required
createdAtstring required
lastUpdatedAtstring required
encryptedboolean required
exportToEnvboolean required

Changes

    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status