Domain methods: create, get
The Domain Verbs create, get as typed SDK methods, with inputs, result, refusals and an example.
Reference for Domain, one group of Domain methods.
Domain.create
Creates a Domain. Verb page.
interface DomainVerbs {
create(input: DomainCreateInput, options?: SB.CallOptions): SB.Call<Domain>
}Emits Domain.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
hostname | string | required | The name, such as leaseline.app. |
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. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
domain | Domain | required | The Domain. |
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. | None. |
Example
import { $ } from 'startup-builder'
const domain = await $.Domain.create({ hostname: 'kilnbakery.com', role: 'canonical' })Domain.get
Returns one Domain by id. Verb page.
interface DomainVerbs {
get(input: DomainGetInput, options?: SB.CallOptions): SB.Call<Domain>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Domain. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
domain | Domain | required | The Domain. |
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. | None. |
Example
import { $ } from 'startup-builder'
const domain = await $.Domain.get({ id: 'domain_VbYut4CTsH' })