List the DNS records of a bought domain

list_dns_records

Lists every DNS record a bought domain holds, with the ones Modulify manages marked as locked.

POST /v1/list_dns_recordsScopedomains:readRead only

The records come by name, with @ first, then by type. Each carries Id, the recordId that update_dns_record and delete_dns_record take, Type, Host, relative to the domain, so @ is the domain itself and www is www.<domain>, Fqdn, Value, Ttl in seconds, Priority for MX and SRV, Weight and Port for SRV, whose Value is its target hostname, Locked and ManagedBy.

Locked true means Modulify manages the record for a site or an email domain of the workspace, and ManagedBy says which: Source (site or email), Purpose (address for a site, or ownership, dkim or receiving for an email domain), Hostname, the site's hostname or the email domain, ProjectId and ProjectName. A locked record cannot be changed or deleted. Modulify deletes it by itself within a minute once that hostname is removed from its site, that email domain is removed, or, for the receiving MX record, receiving is turned off, and listing brings the managed records up to date first.

Records are managed, and answer, only while the domain uses Modulify's nameservers. When its UsesProviderDns is false, the records are kept and none is locked, but other nameservers answer for the domain.

A domain can be read while it is active, expiring or expired, by every member of the workspace, 20 times a minute per person across every domain, shared with the domain's page. See Read the records and Records Modulify manages.

Request

Call it with a POST to https://api.modulify.ai/v1/list_dns_records, sending the inputs below as a JSON object. The token needs the domains:read scope.

It only reads and changes nothing, so retrying it is safe.

curl -X POST https://api.modulify.ai/v1/list_dns_records \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"workspaceId":"WORKSPACE_ID","domainId":"DOMAIN_ID"}'

Over MCP, the same method is the list_dns_records tool.

Inputs

Input Type Required Description
workspaceId string Yes The workspace that owns the domain.
domainId string Yes The _id of the bought domain, from list_bought_domains.

Response

Every call answers with the JSON envelope of success, message, data, code and version. data holds the result described above, and on a method that returns a total, count carries it. The response headers carry the call's X-Request-Id and what is left of your per-minute budget in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Errors explains every status code a call can answer with.