Sign in

v3

latestOpenAPI 3.0.02026-08-081996601.2 MB
Agent Secrets

Replace agent secrets

Replaces the agent's secrets. The submitted map fully replaces the previous set. Names not in the request are removed. Secrets are stored encrypted at rest.

put/v2/agents/{agent_key}/secrets

Path parameters

agent_keystring required

A unique key that identifies an agent.

Example:customer_support

The unique key of the agent.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Request body

secretsobject required

Map of secret name to plaintext value.

Example request

{
  "secrets": {
    "jira_api_token": "ATATT3xFf..."
  }
}

Response

The agent's secrets after the replace, with values masked.

secretsobject required

Map of secret name to masked value.

Example response

{
  "secrets": {
    "jira_api_token": "****",
    "slack_webhook": "****"
  }
}