Get a sender domain configuration

GET

https://api.brevo.com/v3/senders/domains/:domainName

GET

/v3/senders/domains/:domainName

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.domains.getDomainConfiguration({
        domainName: "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.

AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

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