Secret

A secret value, such as an API key for a tool to send, stored for the tenant. Its value is write-only: the API never returns it.

Kind: an object, used in responses.

Fields

Every field is present in a response; empty ones are null.

Field	Type	Description
name	string	The secret’s name, which definitions use to refer to it.
tenantId	uuid	The id of the tenant it belongs to.
id	uuid	The unique id. Use it in by-id routes and wherever another object refers to this one.
dateCreated	datetime	When it was created, in UTC.
dateUpdated	datetime	When it was last changed, in UTC.

Example

{
  "name": "...",
  "tenantId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "dateCreated": "2026-10-26T12:00:00.0000000Z",
  "dateUpdated": "2026-10-26T12:00:00.0000000Z"
}

Where it’s used

• secrets.create (POST /secrets)
• secrets.getByName (GET /secrets/by-name/{name})
• secrets.get (GET /secrets/by-id/{id})
• secrets.list (GET /secrets)
• secrets.update (PUT /secrets/by-id/{id})