Sign in
secrets

Create a secret for an agent.

Changed on

Creates a static or OAuth-backed secret for the agent. Secret values are stored only in OpenBao. OAuth secrets keep refresh lifecycle state in the Secret CRD status.

post/api/secret/{agentName}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/secret/{agentName}
  • Auth: HTTP bearer

Path parameters

agentNamestring required

Agent name.

Query parameters

update_sandboxboolean

When true, append compatible secret hosts that are missing from the agent sandbox allowed host list before creating the secret. Inherited Organisation sandboxes are not changed; the response includes a warning.

Request body

type'static' | 'oauth' required
keystring required

Secret key name. Must be a valid environment variable name.

hostsSecretHost[] required
valuestring

Secret value. Max 48 KB.

Response

Secret created.

Changes

  • 67e362fc730fRevision changes
    • info

      added the optional property to the response with the status

  • f9e13a5159d6Revision changes
    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status