Skip to main content
PATCH
Update a secret

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Path Parameters

secret_id
string
required

The secret's prefix ID (e.g., "secret_abc123")

Body

application/json
value
string

Replacement value. Omit to leave it untouched.

description
string

Human-readable note about what this secret is for.

site_ids
string[]

Sites a shared secret applies to. Empty leaves it dormant — stored, but injected nowhere.

egress_host
string

Host the in-chat agent may call with this secret injected server-side. The value itself is never exposed to the model.

egress_header
string

Header the secret rides in when calling egress_host (e.g. Authorization).

Response

The updated secret (value masked)

object
string
required
id
string
required
name
string
required
target
string
required
scope
string
required
site_id
string | null
required
site_ids
object
required
description
string | null
required
egress_host
string | null
required
egress_header
string | null
required
last4
string
required
value
string | null
required
created_at
string
required