Secrets

Update a secret

Rotates the value or edits the metadata of an existing secret. A secret's name and owning site are fixed at creation; site_ids applies to shared secrets only.

patch/secrets/{secret_id}

Request

  • Base URL: https://api.crevio.co/v1
  • URL: https://api.crevio.co/v1/secrets/{secret_id}
  • Auth: API key in header Authorization

Path parameters

secret_idstring required

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

Request body

valuestring

Replacement value. Omit to leave it untouched.

descriptionstring

Human-readable note about what this secret is for.

site_idsstring[]

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

egress_hoststring

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

egress_headerstring

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

Response

The updated secret (value masked)

objectstring required
idstring required
namestring required
targetstring required
scopestring required
site_idstring nullable required
site_idsobject required
descriptionstring nullable required
egress_hoststring nullable required
egress_headerstring nullable required
egress_placementstring required
egress_signingobject required
egress_default_headersobject required
last4string required
valuestring nullable required
created_atstring required

Changes

No recorded changes to this operation across all 2 revisions of this API.