Domains

Point a domain using the customer's own scoped DNS token.

Writes the records at the customer's DNS provider using a scoped API token they supply. The token is used for the request and discarded: never stored, never logged, never returned. Send it in the body, not the query string, so it stays out of access logs. Touches only conflicting A/AAAA/CNAME/ALIAS records at the hostname being pointed, leaving MX, TXT and every other name intact. On Cloudflare, records are created with proxy disabled, since an orange-clouded record prevents certificate issuance. Supported providers: cloudflare, digitalocean.

post/v1/domains/{id}/dns/apply

Request

  • Base URL: https://api.domainee.dev
  • URL: https://api.domainee.dev/v1/domains/{id}/dns/apply
  • Auth: HTTP bearer

Request body

provider'cloudflare' | 'digitalocean' required
tokenstring required

The customer's scoped DNS API token. Cloudflare needs Zone:Zone:Read and Zone:DNS:Edit; DigitalOcean needs write scope on Domains.

Response

Records written and the domain re-probed.

Example response

{
  "domain": {
    "id": "dom_9f2c",
    "hostname": "app.acme.com",
    "originUrl": "https://acme.vercel.app",
    "dnsRecords": [
      {
        "name": "app.acme.com",
        "value": "edge.domainee.dev",
        "type": "CNAME",
        "purpose": "Traffic Routing"
      }
    ],
    "dnsRecordOptions": [
      {
        "label": "A records",
        "records": [
          {
            "name": "app.acme.com",
            "value": "edge.domainee.dev",
            "type": "CNAME",
            "purpose": "Traffic Routing"
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.