GET/api/v1/projects/{project_id}/domains/{domain_id}/records
Needs scope: readMCP tool: get_required_dns_records
operationId get_required_dns_records
Get a domain's required DNS records
The DNS records the domain needs, for entry by hand: SPF and MX of the
bounce subdomain, DKIM, DMARC, and the tracking host’s CNAME. Built
from the domain and the node’s config (the pool’s addresses, relays,
web.public_url). Needs scope read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
project_idrequired |
path | string · uuid | The project’s id |
domain_idrequired |
path | string · uuid | The domain’s id |
Request body
None.
Responses
200
The records
- RequiredDnsRecords object · all fields required
-
required_recordsarray of RequiredRecordWhat to create in DNS, in this order.
6 fields
- RequiredRecord object · all fields required
-
contentstringThe whole value; a TXT value over 255 characters is split into strings by the DNS provider, not here.
example
v=spf1 ip4:203.0.113.10 -all -
create_only_if_absentbooleanCreate it only if the name has no record of this type, and never change one that is there (the DMARC record).
-
namestringThe owner name, without a trailing dot.
example
bounce.news.example.com -
priorityinteger · int32 | nullThe MX priority;
nullfor other types.≥ 0 · example
10 -
purposeRecordPurposeWhat a required record is for.
- spf_bounce
- mx_bounce
- dkim
- dmarc
- tracking_cname
-
typeRecordTypeThe type of a DNS record.
- txt
- mx
- cname
404
No such project or domain in it, or another project’s (not_found)
422
The node has no usable web.public_url, or no longer declares the domain’s IP pool (precondition_failed)
429
The key is over its rate limit, api.rate_limit_per_minute requests a minute on this node (rate_limited)
| Header | Type | Description |
|---|---|---|
Retry-After | integer | Seconds until the key’s next request passes; rounded up. |
504
Postwind’s storage did not answer within its time limit (storage_timeout). A change the request makes may still take effect: check before repeating it. A repeat with the same Idempotency-Key never runs it twice: it is 409 idempotency_key_in_progress until the key’s 24 h end