CHcheckout
Forward

Create secret

Create a new secret with a plaintext value.

Validation Rules:

  • name: 1-64 characters, alphanumeric + underscore
  • value: max 8KB
  • entity_id (optional): when provided, secret is scoped to this entity

Response: Returns metadata.

post/secrets

Request

Request body

namestring required

Secret name. <br/> Format – 1-64 characters. Alphanumeric and underscore.

valuestring required

Plaintext secret value. Max 8KB.

entity_idstring

Optional.When provided, the secret is scoped to this entity

Example request

{
  "name": "secret_name",
  "value": "my_secret_value",
  "entity_id": "ent_svrxgarj6qru5pzx4m4movyney"
}

Response

Secret created 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.