Lister les domaines et leurs enregistrements

GET /api/v1/domains Tous les domaines déclarés par l'organisation, avec leur statut de vérification et les enregistrements DNS qu'il reste à publier. Les enregistrements ne sont jamais stockés : ils sont relus auprès du fournisseur à chaque appel, parce qu'ils changent si l'identité est recréée.

Autorisation

Rôle dans l'organisationCet endpoint
OWNERAutorisé
ADMINAutorisé
MEMBERAutorisé
Une clé porte le rôle que son créateur détient dans cette organisation — jamais un rôle sur AgentsMail lui-même. Voir Clés d'API.

Exemple

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/domains"

Réponse

  • 200 OK — l'appel a réussi.
  • 401 Unauthorized — clé absente ou invalide, ou son propriétaire a quitté l'organisation.
  • 429 Too Many Requests — plus de 120 requêtes en une minute pour cette clé.

Champs de la réponse

data est un tableau de :
verified répond à la seule question qui compte. Le DKIM prouve que le domaine peut signer ; la preuve TXT prouve que cette organisation le possède. Un domaine peut être à dkimStatus: "SUCCESS" et bloquer quand même, avec ownershipProved: false.
ChampTypeDescription
successbooleanIndique si l'opération a réussi
data[].idstringIdentifiant du domaine déclaré
data[].domainstringLe domaine lui-même
data[].dkimStatusstringPENDING, SUCCESS ou FAILED — les clés de signature
data[].mailFromStatusstring \null
data[].mailFromDomainstring \null
data[].verifiedbooleanLa seule question qui décide de l'envoi : DKIM SUCCESS et propriété prouvée
data[].ownershipProvedbooleanIndique lequel des deux gestes manque encore
data[].lastCheckedAtstring \null
data[].sesUnavailablebooleantrue signifie que vous lisez le dernier état connu, pas la vérité actuelle
data[].dnsRecordsarrayLes enregistrements à publier — {type, name, value, purpose}
paginationobject{total, page, limit, totalPages}

Exemple de réponse

json
{
  "success": true,
  "data": [
    {
      "id": "b71f…",
      "domain": "mail.example.com",
      "dkimStatus": "SUCCESS",
      "mailFromStatus": "SUCCESS",
      "mailFromDomain": "bounce.mail.example.com",
      "verified": true,
      "ownershipProved": true,
      "lastCheckedAt": "2026-08-23T09:41:02.000Z",
      "sesUnavailable": false,
      "dnsRecords": [
        {"type": "CNAME", "name": "abc123._domainkey.mail.example.com", "value": "abc123.dkim.amazonses.com", "purpose": "dkim"},
        {"type": "TXT", "name": "_agentmail-challenge.mail.example.com", "value": "agentmail-verify=9f2c…", "purpose": "ownership"}
      ]
    }
  ]
}

Voir aussi