Skip to content

by Startups.Studio

Core grammar Secret

Secret.revoke

POST /{namespace}/secrets/{secret}/revoke

Revoke ends a Secret so no call fills it again; the record and its history stay.

Noun: Secret
Mode: do
Event: Secret.revoked

You, to your agent

Revoke the latest secret.

curl -X POST https://api.sb/tutorloop.com/secrets/secret_1/revoke \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const secret = await $.Secret.revoke({ secret: 'secret_1' })

npx startup-builder do Secret.revoke --json '{"secret":"secret_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Secret.revoke({ secret: 'secret_1' })"
  }
}

Inputs

Input	Type	Required	Description
`secret`	Secret	required	The Secret to revoke.
`reason`	`text`		Why, such as a leaked value.

Outputs

Output	Type	Required	Description
`secret`	Secret	required	The revoked Secret.

Effects

Emits Secret.revoked.
Performed by the Security Engineer.
One-way (customer): it waits out its delay window, and runs in the send and do modes.
A leaked value revokes at once: a brake never waits.

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

When it waits

Gate	Default
Decision class	Medium: one-way, bounded (customer)
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
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.list

Previous Page

Secret.rotate

Next Page