Skip to content

by Startups.Studio

Product Domains and access Domain

Domain.create

POST /{namespace}/domains

Creates a Domain.

Noun: Domain
Mode: do
Event: Domain.created

You, to your agent

Add a domain to PetPantry.

curl -X POST https://api.sb/petpantry.shop/domains \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"hostname":"petpantry.shop","role":"canonical"}'

import { $ } from 'startup-builder'

const domain = await $.Domain.create({ hostname: 'petpantry.shop', role: 'canonical' })

npx startup-builder do Domain.create --json '{"hostname":"petpantry.shop","role":"canonical"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Domain.create({ hostname: 'petpantry.shop', role: 'canonical' })"
  }
}

Create makes a new Domain from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`hostname`	`string`	required	The name, such as `example.com`.
`role`	`string`	required	What the Domain does for the Thing it serves; a defensive name takes `redirect`.
`acquired`	`string`		One of `claimed`, `purchased`, or `connected`.
`registrant`	Party		The owner of record: the holding Company while held, or the holder of a self-serve Startup’s Stripe account.
`expiresAt`	`datetime`		When the registration ends, as the registrar reports it; empty for a claimed Domain.
`autoRenew`	`boolean`		True when renewal runs without a Decision; false sends the Domain through renewal review.
`renewalPrice`	`money`		What the next renewal costs, which for a premium name differs from the purchase price. Never randomized.
`transferableAt`	`datetime`		The first moment the registrar allows a transfer out, after any registration, transfer or registrant lock.
`names`	`string`		How its subdomains are given out: explicit records only, or one-label claims by other Startups.
`publicSuffix`	`boolean`		True once the public suffix list browsers ship carries the Domain; an issuing Domain gives out no label before then.
`registrarAccount`	`string`		The registrar account that holds the Domain: one per Startup, never shared with a sibling.
`registryLock`	`boolean`		True when the registry refuses transfer, update and delete until a verified out-of-band request lifts it.
`certificate`	`json`		Certificate state (`pending`, `active`, `renewing` or `failed`), its expiry, and the failing check with its fix.
`validation`	`string`		`delegated` proves control through a CNAME to the platform; `serving` is for an apex that cannot hold one.
`walletsEnabled`	`boolean`		True once Stripe lists the Domain as a payment method domain on the Startup’s account.
`carriedIdentity`	`boolean`		True once the Domain received mail, hosted a Mailbox or verified an outside account; it never resets.
`to`	Domain		For a redirect: the canonical Domain it forwards to permanently, path and query kept.
`site`	Site		A Site answers on one or more Domains; each Domain serves one Site.
`tenant`	Tenant		A Tenant proves control of its Customer’s email domain, so sign-ins on that domain follow the Tenant’s policy.

Outputs

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

Effects

Emits Domain.created.
Two-way: try, send, do.

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

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

Previous Page

Domain.delete

Next Page