DNS Record methods
Every DNS Record Verb as a typed SDK method, with its inputs, result, refusals and an example.
Reference for DNS Record.
DNSRecord.get
Returns one DNS Record by id. Verb page.
interface DNSRecordVerbs {
get(input: DNSRecordGetInput, options?: SB.CallOptions): SB.Call<DNSRecord>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the DNS Record. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
dnsRecord | DNS Record | required | The DNS Record. |
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 dnsRecord = await $.DNSRecord.get({ id: 'dns_66ja94YImd' })DNSRecord.list
Returns DNS Records, newest first, one page at a time. Verb page.
interface DNSRecordVerbs {
list(input?: DNSRecordListInput, options?: SB.CallOptions): SB.ListCall<DNSRecord>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
limit | integer | At most this many records, up to 100. The default is 20. | |
after | string | The cursor from the previous page. | |
where | string | A filter over the properties, such as paidAt = null and total.amount > 500. | |
sort | string | Properties to sort by, comma-separated; a leading minus sorts descending. | |
total | boolean | True adds the match count as meta.total, exact up to 10,000 matches and estimated above. | |
facets | string | Properties to count by value, comma-separated, returned as meta.facets. | |
fields | string | Properties to return on each record, comma-separated; $id and $type always return. | |
include | string | Related records to embed in place of their URLs, comma-separated. | |
depth | integer | How many levels of related records to embed. The default is 1. | |
q | string | Words to match across the text properties, ranked by relevance. | |
match | string | Ranks the search by words, or meaning; words is the default. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
dnsRecords | list of DNS Record | required | One page of DNS Records. |
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 dnsRecords = await $.DNSRecord.list({ limit: 20 })DNSRecord.remove
Remove stops a Startup-owned DNS Record from answering; its history stays and a revert restores it. Verb page.
interface DNSRecordVerbs {
remove(input: DNSRecordRemoveInput, options?: SB.CallOptions): SB.Call<DNSRecord>
}Emits DNSRecord.removed.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
record | DNS Record | required | The DNS Record to stop. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
record | DNS Record | required | The stopped DNS Record. |
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. |
| A record the platform owns | refused | Clear what the check names, then call it again. | None. |
Example
import { $ } from 'startup-builder'
const record = await $.DNSRecord.remove({ record: 'dns_66ja94YImd' })DNSRecord.set
Set adds or changes a Startup-owned DNS Record through a Change, previewed against what the Domain answers today. Verb page.
interface DNSRecordVerbs {
set(input: DNSRecordSetInput, options?: SB.CallOptions): SB.Call<DNSRecord>
}Emits DNSRecord.set.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
domain | Domain | required | The Domain the record answers for. |
type | string | required | The record type. |
name | string | required | The label, such as @ or _dmarc. |
value | string | required | The answer. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
record | DNS Record | required | The DNS Record, with its status. |
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. |
| A record the platform owns | refused | Clear what the check names, then call it again. | None. |
Example
import { $ } from 'startup-builder'
const record = await $.DNSRecord.set({ domain: 'domain_JoDiG4ZmXb', type: 'a', name: 'Leaseline', value: 'Example value' })