Skip to content

by Startups.Studio

Product Domains and access API Key

APIKey.revoke

POST /{namespace}/api-keys/{apiKey}/revoke

Revoke stops an API Key at once: its next call fails with 401, and the record and its history stay.

Noun: API Key
Mode: do
Event: APIKey.revoked

You, to your agent

Revoke the latest API key.

curl -X POST https://api.sb/shiftnote.app/api-keys/api_key_1/revoke \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const apiKey = await $.APIKey.revoke({ apiKey: 'api_key_1' })

npx startup-builder do APIKey.revoke --json '{"apiKey":"api_key_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.APIKey.revoke({ apiKey: 'api_key_1' })"
  }
}

Inputs

Input	Type	Required	Description
`apiKey`	API Key	required	The API Key to stop.
`reason`	`text`		Why, shown to the Customer’s admins.

Outputs

Output	Type	Required	Description
`apiKey`	API Key	required	The API Key, with `revokedAt` set.

Effects

Emits APIKey.revoked.
Two-way: it runs at once, in the try, send and do modes.
Emails the Customer’s admins which key stopped, and why.

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

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

APIKey.list

Previous Page

APIKey.roll

Next Page