Skip to content

by Startups.Studio

Product Domains and access Domain

Domain.claim

POST /{namespace}/domains/claim

Claim gives a Startup a one-label name under an issuing Domain, or assigns it a held Domain through an approved Change.

Noun: Domain
Mode: do
Event: Domain.claimed

You, to your agent

Claim the domain “acme.headless.ly” with a startup.

curl -X POST https://api.sb/quietcopy.com/domains/claim \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"hostname":"acme.headless.ly","startup":"startup_1"}'

import { $ } from 'startup-builder'

const domain = await $.Domain.claim({ hostname: 'acme.headless.ly', startup: 'startup_1' })

npx startup-builder do Domain.claim --json '{"hostname":"acme.headless.ly","startup":"startup_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Domain.claim({ hostname: 'acme.headless.ly', startup: 'startup_1' })"
  }
}

Inputs

Input	Type	Required	Description
`hostname`	`string`	required	The name to claim.
`startup`	Startup	required	The Startup it serves.

Outputs

Output	Type	Required	Description
`domain`	Domain	required	The claimed Domain.

Effects

Emits Domain.claimed.
Performed by the Engineering Lead.
Two-way: it runs at once, in the try, send and do modes.
Refuses a label under an issuing Domain whose publicSuffix is false.
Refuses reserved labels such as www, api, admin, mail, mcp, docs and sibling Brands.
Never reissues a label released or renamed before.

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.	Domain.claim
A label under an issuing Domain whose `publicSuffix` is false	`refused`	Clear what the check names, then call it again.	Domain.claim
Reserved labels such as `www`, `api`, `admin`, `mail`, `mcp`, `docs` and sibling Brands	`refused`	Clear what the check names, then call it again.	Domain.claim

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

Domain.benchmark

Previous Page

Domain.connect

Next Page