Skip to content

by Startups.Studio

Product Domains and access DNS Record

DNSRecord.set

POST /{namespace}/dns-records/set

Set adds or changes a Startup-owned DNS Record through a Change, previewed against what the Domain answers today.

Noun: DNS Record
Mode: do
Event: DNSRecord.set

You, to your agent

Set the latest DNS record with a domain.

curl -X POST https://api.sb/tutorloop.com/dns-records/set \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain":"domain_1","type":"a","name":"TutorLoop","value":"Example value"}'

import { $ } from 'startup-builder'

const record = await $.DNSRecord.set({ domain: 'domain_1', type: 'a', name: 'TutorLoop', value: 'Example value' })

npx startup-builder do DNSRecord.set --json '{"domain":"domain_1","type":"a","name":"TutorLoop","value":"Example value"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.DNSRecord.set({ domain: 'domain_1', type: 'a', name: 'TutorLoop', value: 'Example value' })"
  }
}

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.

Outputs

Output	Type	Required	Description
`record`	DNS Record	required	The DNS Record, with its status.

Effects

Emits DNSRecord.set.
Performed by the Reliability Engineer.
Two-way: it runs at once, in the try, send and do modes.
Refuses a record the platform owns.
A revert of its Change restores the previous answer.

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.	DNSRecord.set
A record the platform owns	`refused`	Clear what the check names, then call it again.	DNSRecord.set

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

DNSRecord.remove

Previous Page

Domain

Next Page