Sign in

v3

latestOpenAPI 3.0.02026-08-081996601.2 MB
Agent Secrets

Update agent secrets

Updates the agent's secrets. Names present in the map are added or replaced. Names absent from the map are left unchanged. A name mapped to null is removed.

patch/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 (or null to remove). Names not in the map are left unchanged.

Example request

{
  "secrets": {
    "jira_api_token": "ATATT3xFf...",
    "old_token_to_remove": null
  }
}

Response

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

secretsobject required

Map of secret name to masked value.

Example response

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