GET /v1/domains/{domain}/dns — List All DNS Records

Use this endpoint to retrieve all DNS records currently configured for a domain in your workspace. Each record in the response includes an opaque id field that you’ll need to reference when updating or deleting that record. If the domain is still being provisioned at the registrar, the pendingFulfillment flag will be true — your records are saved and will be applied automatically once provisioning completes.

Endpoint

GET /v1/domains/{domain}/dns

Path Parameters

string

required

The domain name to list DNS records for (e.g. example.com).

Request Example

curl https://api.namegrid.org/v1/domains/example.com/dns \
  -H "x-api-key: ng_live_xxxxxxxxxxxxxxxxxxxxxxxx"

Response

200 OK

array

The list of DNS records configured for the domain.

Show record object

string

Opaque record identifier. Save this value — you’ll need it to update or delete this record later.

string

The DNS record type (e.g. A, AAAA, CNAME, MX, TXT).

string

The record name. @ represents the domain apex (root).

integer

Time to live in seconds. Controls how long resolvers may cache this record.

string

The record value (e.g. an IP address for A records, a hostname for CNAME records).

boolean

true if the domain is still being provisioned at the registrar. Records are saved locally and applied automatically once provisioning completes.

{
  "records": [
    { "id": "b6b0b6a2-...", "type": "A", "name": "@", "ttl": 3600, "value": "192.0.2.1" }
  ],
  "pendingFulfillment": false
}

Save the id from each record object. It’s the only way to reference a specific record when calling the update or delete endpoints.

Overview

Domains

DNS Records

Account

GET /v1/domains/{domain}/dns — List All DNS Records

Endpoint

Path Parameters

Request Example

Response

​Endpoint

​Path Parameters

​Request Example

​Response

Endpoint

Path Parameters

Request Example

Response