Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIProductDomains and access

DNS Record routes

Every DNS Record Verb as an api.sb route, with its inputs, result, refusals and an example.

Reference for DNS Record.

DNSRecord.get

Returns one DNS Record by id. Verb page.

Text
GET /{namespace}/dns-records/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the DNS Record.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
dnsRecordDNS RecordrequiredThe DNS Record.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/dns-records/dns_66ja94YImd \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "DNSRecord",
  "$id": "https://api.sb/leaseline.app/dns-records/dns_66ja94YImd",
  "dnsRecord": {
    "$id": "https://api.sb/leaseline.app/dns-records/dns_66ja94YImd",
    "$type": "DNSRecord",
    "type": "a",
    "name": "_dmarc",
    "value": "192.0.2.10",
    "owner": "platform"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/dns-records/dns_66ja94YImd",
    "up": "https://api.sb/leaseline.app/dns-records"
  },
  "actions": {
    "remove": "https://api.sb/leaseline.app/dns-records/dns_66ja94YImd/remove"
  }
}

DNSRecord.list

Returns DNS Records, newest first, one page at a time. Verb page.

Text
GET /{namespace}/dns-records

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
dnsRecordslist of DNS RecordrequiredOne page of DNS Records.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/dns-records?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "DNSRecord",
  "dnsRecords": [
    {
      "$id": "https://api.sb/leaseline.app/dns-records/dns_66ja94YImd",
      "$type": "DNSRecord",
      "type": "a",
      "name": "_dmarc",
      "value": "192.0.2.10",
      "owner": "platform"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "dns_66ja94YImd"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/dns-records?limit=20",
    "next": "https://api.sb/leaseline.app/dns-records?after=dns_66ja94YImd"
  }
}

DNSRecord.remove

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

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

Path: record. Emits DNSRecord.removed.

Inputs

InputTypeRequiredDescription
recordDNS RecordrequiredThe DNS Record to stop.

Returns

OutputTypeRequiredDescription
recordDNS RecordrequiredThe stopped DNS Record.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
A record the platform ownsrefusedClear what the check names, then call it again.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/dns-records/dns_66ja94YImd/remove \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "record": {
    "$id": "https://api.sb/leaseline.app/dns-records/dns_66ja94YImd",
    "$type": "DNSRecord",
    "type": "a",
    "name": "_dmarc",
    "value": "192.0.2.10",
    "owner": "platform"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "DNSRecord.remove",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

DNSRecord.set

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

Text
POST /{namespace}/dns-records/set

Body, as JSON: the inputs. Emits DNSRecord.set.

Inputs

InputTypeRequiredDescription
domainDomainrequiredThe Domain the record answers for.
typestringrequiredThe record type.
namestringrequiredThe label, such as @ or _dmarc.
valuestringrequiredThe answer.

Returns

OutputTypeRequiredDescription
recordDNS RecordrequiredThe DNS Record, with its status.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
A record the platform ownsrefusedClear what the check names, then call it again.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/dns-records/set \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain":"domain_JoDiG4ZmXb","type":"a","name":"Leaseline","value":"Example value"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "record": {
    "$id": "https://api.sb/leaseline.app/dns-records/dns_66ja94YImd",
    "$type": "DNSRecord",
    "type": "a",
    "name": "_dmarc",
    "value": "192.0.2.10",
    "owner": "platform"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "DNSRecord.set",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

issue, revoke, roll

Previous

Domain

Next