Skip to content

by Startups.Studio

Core grammar Watch

Watch.rotate

POST /{namespace}/watches/{watch}/rotate

Rotate issues a new signing secret for a Watch and signs with both secrets until the old one expires.

Noun: Watch
Mode: do
Event: Watch.rotated

You, to your agent

Rotate the latest watch.

curl -X POST https://api.sb/kilnbakery.com/watches/watch_1/rotate \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const { watch, secret } = await $.Watch.rotate({ watch: 'watch_1' })

npx startup-builder do Watch.rotate --json '{"watch":"watch_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Watch.rotate({ watch: 'watch_1' })"
  }
}

Inputs

Input	Type	Required	Description
`watch`	Watch	required	The Watch whose secret changes.
`overlap`	`string`		How long the old secret keeps signing, as an ISO 8601 duration; defaults to `PT24H`.

Outputs

Output	Type	Required	Description
`watch`	Watch	required	The Watch, signing with both secrets.
`secret`	`string`	required	The new signing secret, shown once.

Effects

Emits Watch.rotated.
Adds a second signature to every delivery until the overlap ends.
Retires the old secret when the overlap ends.

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.	Watch.rotate

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`.

Watch.resume

Previous Page

Watch.update

Next Page