Skip to documentation
Dashboard
Domains

List DNS records

Retrieve the exact required record type, host, value, purpose, and current state.

GET/api/v1/domains/{domainId}/dns-records
On this page

Authentication

Send a RouteKite API key as a Bearer token. This endpoint requires the domain:read, domain:manage, or email:send scope.

Required headers
NameTypeRequirementDescription
AuthorizationstringRequiredBearer API key with the required workspace scope.Example: Bearer rk_your_key

Path parameters

Path parameters
NameTypeRequirementDescription
domainIduuidRequiredDomain identifier returned by RouteKite.

Response

Response fields
NameTypeRequirementDescription
objectstringAlwaysAlways list.
domain_iduuidAlwaysOwning domain ID.
data[].typestringAlwaysCNAME, MX, or TXT.
data[].hoststringAlwaysHost or Name to publish.
data[].valuestringAlwaysExact record value.
data[].statusstringAlwaysready, waiting, or needs_attention.

Publish exact values

Copy the host and value exactly. Some DNS dashboards automatically append the domain name, so confirm the final published host before verifying.

Errors

StatusCodeWhat it meansWhat to do
401UNAUTHORIZEDThe API key is invalid.Check the Bearer header.
403FORBIDDENThe key cannot read sending configuration.Use domain:read, domain:manage, or legacy email:send access.
404DOMAIN_NOT_FOUNDThe domain is not in this workspace.Check the domain ID and API key workspace.
429RATE_LIMITEDToo many requests were made.Honor Retry-After before retrying.
503SETUP_UNAVAILABLEConfiguration could not be loaded.Retry after a short delay.