Get Domain DNS Records

GET

api

domains

{id}

dns-records

import { InboundEmailClient } from '@inboundemail/sdk'

const inbound = new InboundEmailClient('YOUR_API_KEY')

const { data, error } = await inbound.domain.getDnsRecords('dom_abc123')
if (error) {
  console.error('Error:', error)
} else {
  console.log('DNS Records:', data)
}

{
  "domainId": "dom_abc123",
  "domain": "example.com",
  "records": [
    {
      "id": "dns_rec_001",
      "domainId": "dom_abc123",
      "recordType": "TXT",
      "name": "_amazonses.example.com",
      "value": "abc123def456ghi789jkl",
      "priority": null,
      "isRequired": true,
      "isVerified": true,
      "lastChecked": "2024-01-15T10:30:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    },
    {
      "id": "dns_rec_002",
      "domainId": "dom_abc123",
      "recordType": "MX",
      "name": "example.com",
      "value": "10 inbound-smtp.us-east-1.amazonaws.com",
      "priority": null,
      "isRequired": true,
      "isVerified": false,
      "lastChecked": "2024-01-15T10:25:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    },
    {
      "id": "dns_rec_003",
      "domainId": "dom_abc123",
      "recordType": "TXT",
      "name": "example.com",
      "value": "v=spf1 include:amazonses.com ~all",
      "priority": null,
      "isRequired": false,
      "isVerified": false,
      "lastChecked": "2024-01-15T10:25:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    },
    {
      "id": "dns_rec_004",
      "domainId": "dom_abc123",
      "recordType": "TXT",
      "name": "_dmarc.example.com",
      "value": "v=DMARC1; p=none; rua=mailto:dmarc@example.com; ruf=mailto:dmarc@example.com; fo=1; aspf=r; adkim=r",
      "priority": null,
      "isRequired": false,
      "isVerified": false,
      "lastChecked": "2024-01-15T10:25:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Overview

This endpoint retrieves all DNS records that are required for domain verification. It includes both the records that need to be added to your DNS provider and their current verification status.

Authentication

Authorization

string

required

Bearer token for API authentication. Format: Bearer YOUR_API_KEY

Parameters

string

required

The unique identifier of the domain to retrieve DNS records for.

Response

domainId

string

required

The unique identifier of the domain.

domain

string

required

The domain name (e.g., “example.com”).

records

array

required

Array of DNS records required for domain verification.

Show DNS record properties

string

required

Unique identifier for the DNS record.

domainId

string

required

The domain ID this record belongs to.

recordType

string

required

Type of DNS record (e.g., “TXT”, “MX”, “CNAME”).

name

string

required

The DNS record name/hostname that needs to be created.

value

string

required

The DNS record value that needs to be set.

priority

integer | null

Priority for MX records (typically 10). Null for other record types.

isRequired

boolean

required

Whether this DNS record is required for domain verification.

isVerified

boolean

required

Whether this DNS record has been verified as correctly configured.

lastChecked

string | null

ISO 8601 timestamp of when this record was last checked for verification.

createdAt

string

required

ISO 8601 timestamp when the DNS record was created.

updatedAt

string

required

ISO 8601 timestamp when the DNS record was last updated.

Examples

Request

import { InboundEmailClient } from '@inboundemail/sdk'

const inbound = new InboundEmailClient('YOUR_API_KEY')

const { data, error } = await inbound.domain.getDnsRecords('dom_abc123')
if (error) {
  console.error('Error:', error)
} else {
  console.log('DNS Records:', data)
}

Response

{
  "domainId": "dom_abc123",
  "domain": "example.com",
  "records": [
    {
      "id": "dns_rec_001",
      "domainId": "dom_abc123",
      "recordType": "TXT",
      "name": "_amazonses.example.com",
      "value": "abc123def456ghi789jkl",
      "priority": null,
      "isRequired": true,
      "isVerified": true,
      "lastChecked": "2024-01-15T10:30:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    },
    {
      "id": "dns_rec_002",
      "domainId": "dom_abc123",
      "recordType": "MX",
      "name": "example.com",
      "value": "10 inbound-smtp.us-east-1.amazonaws.com",
      "priority": null,
      "isRequired": true,
      "isVerified": false,
      "lastChecked": "2024-01-15T10:25:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    },
    {
      "id": "dns_rec_003",
      "domainId": "dom_abc123",
      "recordType": "TXT",
      "name": "example.com",
      "value": "v=spf1 include:amazonses.com ~all",
      "priority": null,
      "isRequired": false,
      "isVerified": false,
      "lastChecked": "2024-01-15T10:25:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    },
    {
      "id": "dns_rec_004",
      "domainId": "dom_abc123",
      "recordType": "TXT",
      "name": "_dmarc.example.com",
      "value": "v=DMARC1; p=none; rua=mailto:dmarc@example.com; ruf=mailto:dmarc@example.com; fo=1; aspf=r; adkim=r",
      "priority": null,
      "isRequired": false,
      "isVerified": false,
      "lastChecked": "2024-01-15T10:25:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Error Responses

{
  "error": "Domain not found"
}

DNS Record Types

The following DNS record types are commonly used for domain verification:

TXT Records

Used for domain verification and AWS SES identity verification.

Name: _amazonses.example.com
Value: abc123def456ghi789jkl

MX Records

Used to route emails to the correct mail servers.

Name: example.com
Value: 10 inbound-smtp.us-east-1.amazonaws.com
Priority: 10

SPF Records (TXT)

Used for email authentication to specify which servers can send emails on behalf of your domain.

Name: example.com
Value: v=spf1 include:amazonses.com ~all

SPF records help prevent email spoofing by specifying authorized mail servers. The ~all indicates a “soft fail” for unauthorized servers, while -all would be a “hard fail”.

DMARC Records (TXT)

Used for email authentication policy to specify how receiving servers should handle emails that fail SPF or DKIM checks.

Name: _dmarc.example.com
Value: v=DMARC1; p=none; rua=mailto:dmarc@example.com; ruf=mailto:dmarc@example.com; fo=1; aspf=r; adkim=r

DMARC records provide reporting and policy instructions. The p=none policy is recommended for monitoring, while p=quarantine or p=reject provide stronger protection once you’ve verified your email authentication setup.

CNAME Records

Sometimes used for specific subdomain configurations.

Name: mail.example.com
Value: inbound-smtp.us-east-1.amazonaws.com

Verification Status

Each DNS record has a verification status that indicates whether it’s properly configured:

Not Verified (isVerified: false)

The DNS record has not been verified yet or is incorrectly configured.

Check that the record has been added to your DNS provider with the exact name and value.

Verified (isVerified: true)

The DNS record has been verified and is correctly configured.

This record is properly set up and contributing to domain verification.

Common DNS Configuration

Here’s how to configure the most common DNS records:

Adding TXT Records

Log into your DNS provider (Cloudflare, GoDaddy, etc.)
Navigate to DNS management
Add a new TXT record with the exact name and value provided
Save the changes

Adding MX Records

Remove any existing MX records for the domain
Add the new MX record with the provided hostname and priority
Ensure no conflicting MX records exist

Important Notes

DNS propagation can take up to 24 hours, but typically completes within 1-2 hours. Check the lastChecked timestamp to see when verification was last attempted.

Use the domain’s GET endpoint with check=true to trigger a real-time verification check of all DNS records.

All required DNS records must be verified before the domain can receive emails. Missing or incorrect records will prevent email delivery.

Troubleshooting

If DNS records are not verifying:

Check DNS propagation: Use online DNS lookup tools to verify records are visible
Verify exact values: Ensure the name and value match exactly (case-sensitive)
Remove conflicting records: Delete any existing MX or CNAME records that might conflict
Wait for propagation: DNS changes can take time to propagate globally

Trigger verification check: GET /api/v2/domains/{id}?check=true
View domain status: GET /api/v2/domains/{id}
List all domains: GET /api/v2/domains

Notes

DNS records are automatically created when a domain is added
The isVerified status is updated during verification checks
All required records must be verified for the domain to become active
DNS records are automatically deleted when a domain is removed
Record verification happens automatically but can be triggered manually

1.0 - ✅

List EmailsRetrieve all emails with filtering, pagination, and search capabilities

import { InboundEmailClient } from '@inboundemail/sdk'

const inbound = new InboundEmailClient('YOUR_API_KEY')

const { data, error } = await inbound.domain.getDnsRecords('dom_abc123')
if (error) {
  console.error('Error:', error)
} else {
  console.log('DNS Records:', data)
}

{
  "domainId": "dom_abc123",
  "domain": "example.com",
  "records": [
    {
      "id": "dns_rec_001",
      "domainId": "dom_abc123",
      "recordType": "TXT",
      "name": "_amazonses.example.com",
      "value": "abc123def456ghi789jkl",
      "priority": null,
      "isRequired": true,
      "isVerified": true,
      "lastChecked": "2024-01-15T10:30:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    },
    {
      "id": "dns_rec_002",
      "domainId": "dom_abc123",
      "recordType": "MX",
      "name": "example.com",
      "value": "10 inbound-smtp.us-east-1.amazonaws.com",
      "priority": null,
      "isRequired": true,
      "isVerified": false,
      "lastChecked": "2024-01-15T10:25:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    },
    {
      "id": "dns_rec_003",
      "domainId": "dom_abc123",
      "recordType": "TXT",
      "name": "example.com",
      "value": "v=spf1 include:amazonses.com ~all",
      "priority": null,
      "isRequired": false,
      "isVerified": false,
      "lastChecked": "2024-01-15T10:25:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    },
    {
      "id": "dns_rec_004",
      "domainId": "dom_abc123",
      "recordType": "TXT",
      "name": "_dmarc.example.com",
      "value": "v=DMARC1; p=none; rua=mailto:dmarc@example.com; ruf=mailto:dmarc@example.com; fo=1; aspf=r; adkim=r",
      "priority": null,
      "isRequired": false,
      "isVerified": false,
      "lastChecked": "2024-01-15T10:25:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Quickstart

Sending Emails

Endpoints

Email Addresses

Domains

Inbound Emails

Get Domain DNS Records

Overview

Authentication

Parameters

Response

Examples

Request

Response

Error Responses

DNS Record Types

TXT Records

MX Records

SPF Records (TXT)

DMARC Records (TXT)

CNAME Records

Verification Status

Common DNS Configuration

Adding TXT Records

Adding MX Records

Important Notes

Troubleshooting

Notes

Quickstart

Sending Emails

Endpoints

Email Addresses

Domains

Inbound Emails

​Overview

​Authentication

​Parameters

​Response

​Examples

​Request

​Response

​Error Responses

​DNS Record Types

​TXT Records

​MX Records

​SPF Records (TXT)

​DMARC Records (TXT)

​CNAME Records

​Verification Status

​Common DNS Configuration

​Adding TXT Records

​Adding MX Records

​Important Notes

​Troubleshooting

​Related Endpoints

​Notes

Overview

Authentication

Parameters

Response

Examples

Request

Response

Error Responses

DNS Record Types

TXT Records

MX Records

SPF Records (TXT)

DMARC Records (TXT)

CNAME Records

Verification Status

Common DNS Configuration

Adding TXT Records

Adding MX Records

Important Notes

Troubleshooting

Related Endpoints

Notes