Secret · StartupBuilder

Properties

Property	Type	Required	Description
`name`	`string`	required	The name a Function declares, such as `MAPS_KEY`; `list` returns names only.
`environment`	`string`	required	The environment that holds this value; a Function deploys to `live` only when every declared Secret exists there.
`scope`	`string`	required	Whether the whole Startup or one Tenant holds it.
`rotatedAt`	`datetime`		When the value last changed.

Object

JSON

{
  "$id": "https://api.sb/kilnbakery.com/secrets/secret_1",
  "$type": "Secret",
  "name": "MAPS_KEY",
  "environment": "test",
  "scope": "startup",
  "rotatedAt": "2026-10-22T12:00:00Z"
}

Relationships

A Secret is used by many Functions: a Function declares the Secrets it reads; deploying to live fails when one is missing there. usedBy, inverse uses.

Verbs

getReturns one Secret by id.
GET /{namespace}/secrets/{id}readNo Event
listReturns Secrets, newest first, one page at a time.
GET /{namespace}/secretsreadNo Event
revokeRevoke ends a Secret so no call fills it again; the record and its history stay.
POST /{namespace}/secrets/{secret}/revokedoSecret.revoked
rotateRotate replaces a Secret’s value, and calls already running finish on the old one.
POST /{namespace}/secrets/{secret}/rotatedoSecret.rotated
storeStore writes a Secret’s value for one environment; the value is never returned by any Interface.
POST /{namespace}/secrets/storedoSecret.stored

A Secret is never deleted: it ends by Secret.revoke, and its records stay.

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operation	`owner`	`admin`	`member`	`viewer`
`Secret.get`	Yes	Yes	Yes	Yes
`Secret.list`	Yes	Yes	Yes	Yes
`Secret.revoke`	Yes	No	No	No
`Secret.rotate`	Yes	Yes	No	No
`Secret.store`	Yes	Yes	No	No

Call it

Text

Store the secret “MAPS_KEY”.

Example

A delivery app's Function declares MAPS_KEY. The key is stored once in the test environment and once in live, and the Function deploys to live only after both exist.

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

RelationshipsCopy Anchor Link

VerbsCopy Anchor Link

PermissionsCopy Anchor Link

Call itCopy Anchor Link

ExampleCopy Anchor Link