DNS Records

Create or update a managed DNS record (ownership-guarded)

Changed on
post/dns-records

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/dns-records
  • Auth: HTTP bearer

Request body

domainstring required

Domain (any FQDN under a managed zone)

environment_idinteger nullable

Environment this record belongs to (stamped into the ownership marker)

namestring required

Record name relative to the zone ("@" for apex)

project_idinteger nullable

Project this record belongs to (stamped into the ownership marker)

proxiedboolean nullable

Proxy through the provider's CDN (Cloudflare orange-cloud). Also enabled by the managed domain's proxied_by_default.

ttlinteger nullable

TTL in seconds (None = provider default)

Example request

{
  "content": {
    "value": {
      "address": "192.0.2.1"
    }
  },
  "domain": "example.com",
  "name": "app"
}

Response

Record set

fqdnstring required

Fully qualified domain name

idstring nullable

Provider-specific record ID (if exists)

metadataobject

Provider-specific metadata

namestring required

Record name (without zone, e.g., "www" or "@" for root)

proxiedboolean

Whether this record is proxied (Cloudflare-specific)

ttlinteger required

Time to live in seconds

zonestring required

Zone/domain this record belongs to

Example response

{
  "content": {
    "value": {
      "address": "192.0.2.1"
    }
  },
  "fqdn": "www.example.com",
  "id": "abc123",
  "name": "www",
  "ttl": 300,
  "zone": "example.com"
}

Changes