DNS Records

Get the ownership state of a DNS record

Changed on
get/dns-records/ownership

Request

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

Query parameters

domainstring required

Domain (any FQDN under a managed zone)

namestring required

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

record_type'A' | 'AAAA' | 'CNAME' | 'TXT' | 'MX' | 'NS' | 'SRV' | 'CAA' | 'PTR' required

DNS record types

Record type

Response

Ownership state

environment_idinteger nullable

Environment stamped in the ownership marker, when owned

owner_instancestring nullable

Owning install's instance ID when owned by a different temps install

project_idinteger nullable

Project stamped in the ownership marker, when owned

statusstring required

One of: not_found | unmanaged | owned | owned_by_other | orphaned | blocked_by_other | registry_conflict

writableboolean required

Whether this temps install may modify the record

Example response

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

Changes