# DNS Record routes

URL: /code/api/dns-record · Id: `page:code/api/dns-record`

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

Reference for [DNS Record](/business/nouns/dns-record).

### DNSRecord.get
Returns one DNS Record by id. [Verb page](/business/nouns/dns-record/get?interface=api).

```text
GET /{namespace}/dns-records/{id}
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the DNS Record. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `dnsRecord` | [DNS Record](/business/nouns/dns-record) | Yes | The DNS Record. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
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](/business/nouns/dns-record/list?interface=api).

```text
GET /{namespace}/dns-records
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | At most this many records, up to 100. The default is 20. |
| `after` | `string` | No | The cursor from the previous page. |
| `where` | `string` | No | A filter over the properties, such as `paidAt = null and total.amount > 500`. |
| `sort` | `string` | No | Properties to sort by, comma-separated; a leading minus sorts descending. |
| `total` | `boolean` | No | True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above. |
| `facets` | `string` | No | Properties to count by value, comma-separated, returned as `meta.facets`. |
| `fields` | `string` | No | Properties to return on each record, comma-separated; `$id` and `$type` always return. |
| `include` | `string` | No | Related records to embed in place of their URLs, comma-separated. |
| `depth` | `integer` | No | How many levels of related records to embed. The default is 1. |
| `q` | `string` | No | Words to match across the text properties, ranked by relevance. |
| `match` | `string` | No | Ranks the search by `words`, or `meaning`; words is the default. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `dnsRecords` | list of [DNS Record](/business/nouns/dns-record) | Yes | 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`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
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](/business/nouns/dns-record/remove?interface=api).

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

Path: `record`. Emits [`DNSRecord.removed`](/business/events/DNSRecord.removed).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `record` | [DNS Record](/business/nouns/dns-record) | Yes | The DNS Record to stop. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `record` | [DNS Record](/business/nouns/dns-record) | Yes | The stopped DNS Record. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/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`](/code/api/errors/refused) | Clear what the check names, then call it again. | None. |

**Example**

```bash
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](/business/nouns/dns-record/set?interface=api).

```text
POST /{namespace}/dns-records/set
```

Body, as JSON: the inputs. Emits [`DNSRecord.set`](/business/events/DNSRecord.set).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `domain` | [Domain](/business/nouns/domain) | Yes | The Domain the record answers for. |
| `type` | `string` | Yes | The record type. |
| `name` | `string` | Yes | The label, such as `@` or `_dmarc`. |
| `value` | `string` | Yes | The answer. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `record` | [DNS Record](/business/nouns/dns-record) | Yes | 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`](/code/api/errors/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`](/code/api/errors/refused) | Clear what the check names, then call it again. | None. |

**Example**

```bash
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"
  }
}
```