Get a sender domain configuration | Brevo API Documentation

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.domains.getDomainConfiguration("domainName");
}
main();

{
  "domain": "mycompany.com",
  "verified": true,
  "authenticated": true,
  "dns_records": {
    "brevo_code": {
      "host_name": "@",
      "type": "TXT",
      "value": "brevo-code=abc123def456",
      "status": true
    },
    "dkim_record": {
      "host_name": "mail._domainkey",
      "type": "TXT",
      "value": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GN...",
      "status": true
    },
    "dmarc_record": {
      "host_name": "_dmarc",
      "type": "TXT",
      "value": "v=DMARC1; p=quarantine; rua=mailto:dmarc@mycompany.com",
      "status": true
    }
  }
}

Retrieves configuration of a specific domain, to know if the domain is valid or not. Use this to: - Check domain configuration - Validate a domain configuration - Monitor DNS record status - Troubleshoot authentication issues Key information returned: - Domain verification and authentication status - DNS records configuration and validation status - Detailed authentication requirements

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.domains.getDomainConfiguration("domainName");
}
main();

{
  "domain": "mycompany.com",
  "verified": true,
  "authenticated": true,
  "dns_records": {
    "brevo_code": {
      "host_name": "@",
      "type": "TXT",
      "value": "brevo-code=abc123def456",
      "status": true
    },
    "dkim_record": {
      "host_name": "mail._domainkey",
      "type": "TXT",
      "value": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GN...",
      "status": true
    },
    "dmarc_record": {
      "host_name": "_dmarc",
      "type": "TXT",
      "value": "v=DMARC1; p=quarantine; rua=mailto:dmarc@mycompany.com",
      "status": true
    }
  }
}

Retrieves configuration of a specific domain, to know if the domain is valid or not.

Use this to:

Check domain configuration
Validate a domain configuration
Monitor DNS record status
Troubleshoot authentication issues

Key information returned:

Domain verification and authentication status
DNS records configuration and validation status
Detailed authentication requirements

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

domainNamestringRequired

Domain name

Response

Domain configuration retrieved successfully

domainstring

Domain name

verifiedboolean

Status of domain verification (true=verified, false=non verified)

authenticatedboolean

Status of domain authentication (true=authenticated, false=non authenticated)

dns_recordsobject

DNS records configuration and status

Errors

400

Bad Request Error

404

Not Found Error

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.domains.getDomainConfiguration("domainName");
8	}
9	main();

1	{
2	"domain": "mycompany.com",
3	"verified": true,
4	"authenticated": true,
5	"dns_records": {
6	"brevo_code": {
7	"host_name": "@",
8	"type": "TXT",
9	"value": "brevo-code=abc123def456",
10	"status": true
11	},
12	"dkim_record": {
13	"host_name": "mail._domainkey",
14	"type": "TXT",
15	"value": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GN...",
16	"status": true
17	},
18	"dmarc_record": {
19	"host_name": "_dmarc",
20	"type": "TXT",
21	"value": "v=DMARC1; p=quarantine; rua=mailto:dmarc@mycompany.com",
22	"status": true
23	}
24	}
25	}