Skip to content

by Startups.Studio

Product Domains and access DNS Record

DNSRecord.remove

POST /{namespace}/dns-records/{record}/remove

Remove stops a Startup-owned DNS Record from answering; its history stays and a revert restores it.

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

You, to your agent

Remove the latest DNS record.

curl -X POST https://api.sb/petpantry.shop/dns-records/dns_record_1/remove \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const record = await $.DNSRecord.remove({ record: 'dns_record_1' })

npx startup-builder do DNSRecord.remove --json '{"record":"dns_record_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.DNSRecord.remove({ record: 'dns_record_1' })"
  }
}

Inputs

Input	Type	Required	Description
`record`	DNS Record	required	The DNS Record to stop.

Outputs

Output	Type	Required	Description
`record`	DNS Record	required	The stopped DNS Record.

Effects

Emits DNSRecord.removed.
Performed by the Reliability Engineer.
Two-way: it runs at once, in the try, send and do modes.
Refuses a record the platform owns.

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

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

Previous Page

DNSRecord.set

Next Page