CHcheckout
Forward

Update secret

Update an existing secret. After updating, the version is automatically incremented.

Validation Rules:

  • Only value and entity_id can be updated
  • value: max 8KB

Response: Returns updated metadata with incremented version.

patch/secrets/{name}

Request

Path parameters

namestring required

Secret name.

Request body

entity_idstring

Update the entity scope.

valuestring

New plaintext secret value. Max 8KB.

Example request

{
  "entity_id": "ent_kf3pqe272lqevcpx5xtlndgcii",
  "value": "NEW_VALUE_1"
}

Response

Secret updated successfully

namestring required

Secret name (1-64 characters, alphanumeric and underscore)

created_atstring date-time required

Timestamp when the secret was created.

updated_atstring date-time required

Timestamp when the secret was last updated.

versioninteger required

Version number.

entity_idstring

Entity ID if the secret is scoped to a specific entity.

Example response

{
  "name": "secret_name",
  "created_at": "2025-10-14T00:00:00.0000000+00:00",
  "updated_at": "2025-10-14T00:00:00.0000000+00:00",
  "version": 1,
  "entity_id": "ent_123"
}

Changes

No recorded changes to this operation across all 1 revision of this API.