Skip to content

by Startups.Studio

Core grammar Tenant

Tenant.pin

POST /{namespace}/tenants/{tenant}/pin

Pin moves a Tenant’s keys to another API version, or to `latest`, once a call with its test key passes there.

Noun: Tenant
Mode: do
Event: Tenant.pinned

You, to your agent

Pin the latest tenant.

curl -X POST https://api.sb/patentpad.com/tenants/tenant_1/pin \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"apiVersion":"v2"}'

import { $ } from 'startup-builder'

const tenant = await $.Tenant.pin({ tenant: 'tenant_1', apiVersion: 'v2' })

npx startup-builder do Tenant.pin --json '{"tenant":"tenant_1","apiVersion":"v2"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Tenant.pin({ tenant: 'tenant_1', apiVersion: 'v2' })"
  }
}

Pin moves a Tenant’s keys to another API version, or to latest, once a call with its test key passes there.

Inputs

Input	Type	Required	Description
`tenant`	Tenant	required	The Tenant whose keys move.
`apiVersion`	`string`	required	The version to answer at, such as `v2`, or `latest` to track the newest.

Outputs

Output	Type	Required	Description
`tenant`	Tenant	required	The Tenant, answering at its new version.

Effects

Emits Tenant.pinned.
Two-way: it runs at once, in the try, send and do modes.
Refuses until a call with the Tenant’s test key succeeds at the target version.
Leaves each Watch at the version current when it was created.

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.	Tenant.pin
Until a call with the Tenant’s test key succeeds at the target version	`refused`	Clear what the check names, then call it again.	Tenant.pin

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

Tenant.list

Previous Page

Tenant.provision

Next Page