Skip to content

by Startups.Studio

Core grammar Secret

Secret.store

POST /{namespace}/secrets/store

Store writes a Secret’s value for one environment; the value is never returned by any Interface.

Noun: Secret
Mode: do
Event: Secret.stored

You, to your agent

Store the secret “MAPS_KEY”.

curl -X POST https://api.sb/shiftnote.app/secrets/store \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"MAPS_KEY","value":"Example value","environment":"test"}'

import { $ } from 'startup-builder'

const secret = await $.Secret.store({ name: 'MAPS_KEY', value: 'Example value', environment: 'test' })

npx startup-builder do Secret.store --json '{"name":"MAPS_KEY","value":"Example value","environment":"test"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Secret.store({ name: 'MAPS_KEY', value: 'Example value', environment: 'test' })"
  }
}

Inputs

Input	Type	Required	Description
`name`	`string`	required	The name Functions declare.
`value`	`string`	required	The credential; write-only.
`environment`	`string`	required	Where it holds.

Outputs

Output	Type	Required	Description
`secret`	Secret	required	The Secret, without its value.

Effects

Emits Secret.stored.
Performed by the Security Engineer.
Two-way: it runs at once, in the try, send and do modes.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Secret.store

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Secret.rotate

Previous Page

Setting

Next Page