Domain methods: transfer, verify

Reference for Domain, one group of Domain methods.

Domain.transfer

Transfer moves a Domain’s registration to another holder or registrar, with its records intact. Verb page.

TypeScript

interface DomainVerbs {
  transfer(input: DomainTransferInput, options?: SB.CallOptions): SB.Call<Domain>
}

Inputs

Input	Type	Required	Description
`domain`	Domain	required	The Domain to move.
`to`	`string`	required	The receiving holder or registrar.
`kind`	`string`	required	`in` from another registrar, `registrant` to a new owner, `push` between accounts, or `out` to leave.
`code`	Secret		The transfer code, for `in` and `out`.

Returns

Output	Type	Required	Description
`domain`	Domain	required	The transferred 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.
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	None.
Before `transferableAt`	`refused`	Clear what the check names, then call it again.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const domain = await $.Domain.transfer({ domain: 'domain_VbYut4CTsH', to: 'Example to', kind: 'in' })

Verify checks a Domain’s DNS, ownership and certificate again and records each result, with the fix for any failure. Verb page.

TypeScript

interface DomainVerbs {
  verify(input: DomainVerifyInput, options?: SB.CallOptions): SB.Call<DomainVerifyOutput>
}

Inputs

Input	Type	Required	Description
`domain`	Domain	required	The Domain to check.

Returns

Output	Type	Required	Description
`checks`	`json`	required	Each check with its status and, on failure, its reason and fix.
`domain`	Domain	required	The Domain with its `state` after the checks.

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

TypeScript

import { $ } from 'startup-builder'

const { checks, domain } = await $.Domain.verify({ domain: 'domain_VbYut4CTsH' })