get
/domainsLister les domaines
Domaines de l'organisation, plus récents d'abord, avec le dernier scan. Portée minimale : viewer.
Clé d'API requise.
Réponses
200 Liste des domaines401 Clé absente (`apiKeyMissing`) ou invalide, révoquée (`apiKeyInvalid`)402 Forfait insuffisant : API non comprise dans le forfait de l'organisation (`planFeatureApi`) ou limite de domaines atteinte (`planLimitDomains`, `POST /domains`)429 Limite de débit atteinte (`tooManyRequests`)500 Erreur interne (`internal`)
post
/domainsAjouter un domaine
Ajoute un domaine à l'organisation et le scanne aussitôt (réponse synchrone, quelques secondes). Avec `scan: false`, le domaine est ajouté sans scan : le premier scan est fait par le monitoring. Portée minimale : member. Compte dans la limite de scans.
Clé d'API requise.
Corps JSON : CreateDomainRequest
Réponses
201 Domaine ajouté (et scan si demandé)400 Requête invalide (codes `invalidJson`, `invalidRequest`, `domainRequired`, `domainInvalid`, `apiSinceInvalid`...)401 Clé absente (`apiKeyMissing`) ou invalide, révoquée (`apiKeyInvalid`)402 Forfait insuffisant : API non comprise dans le forfait de l'organisation (`planFeatureApi`) ou limite de domaines atteinte (`planLimitDomains`, `POST /domains`)403 Portée de la clé insuffisante (`apiKeyScope`)409 Domaine déjà suivi (code `apiDomainExists`)429 Limite de débit atteinte (`tooManyRequests`)500 Erreur interne (`internal`)
post
/domains/{domain}/scanScanner un domaine
Scan complet (SPF, DKIM, DMARC, listes noires, vérifications avancées) d'un domaine déjà suivi. Réponse synchrone. Déclenche l'événement `scan.completed`. Portée minimale : member. Compte dans la limite de scans.
Clé d'API requise.
Paramètres
domain (chemin, obligatoire) - Nom de domaine suivi par l'organisation (ex. exemple.ca).
Corps JSON : ScanRequest (facultatif)
Réponses
201 Scan terminé400 Requête invalide (codes `invalidJson`, `invalidRequest`, `domainRequired`, `domainInvalid`, `apiSinceInvalid`...)401 Clé absente (`apiKeyMissing`) ou invalide, révoquée (`apiKeyInvalid`)402 Forfait insuffisant : API non comprise dans le forfait de l'organisation (`planFeatureApi`) ou limite de domaines atteinte (`planLimitDomains`, `POST /domains`)403 Portée de la clé insuffisante (`apiKeyScope`)404 Ressource absente de l'organisation (`domainNotFound`, `scanNotFound`)429 Limite de débit atteinte (`tooManyRequests`)500 Erreur interne (`internal`)
get
/domains/{domain}/dmarcRapports DMARC agrégés
Statistiques des rapports DMARC agrégés (RFC 7489) reçus à l'adresse de réception du domaine (`address`, créée depuis l'interface, page DMARC du domaine) : volume et taux de pass (DKIM ou SPF aligné) sur 7, 30 et 90 jours, tendance quotidienne, sources d'envoi par IP (PTR, fournisseur, pays, classement `authorized`, `review` ou `unauthorized`, 50 principales), rapporteurs. Les rapports arrivent en général 24 à 48 h après l'envoi des courriels et sont conservés 13 mois. Paramètre `days` invalide : 400 (code `dmarcDaysInvalid`). Portée minimale : viewer.
Clé d'API requise.
Paramètres
domain (chemin, obligatoire) - Nom de domaine suivi par l'organisation (ex. exemple.ca).days (requête) - Période du détail (tendance, sources, rapporteurs) : 7, 30 (défaut) ou 90 jours.
Réponses
200 Statistiques DMARC400 Requête invalide (codes `invalidJson`, `invalidRequest`, `domainRequired`, `domainInvalid`, `apiSinceInvalid`...)401 Clé absente (`apiKeyMissing`) ou invalide, révoquée (`apiKeyInvalid`)402 Forfait insuffisant : API non comprise dans le forfait de l'organisation (`planFeatureApi`) ou limite de domaines atteinte (`planLimitDomains`, `POST /domains`)404 Ressource absente de l'organisation (`domainNotFound`, `scanNotFound`)429 Limite de débit atteinte (`tooManyRequests`)500 Erreur interne (`internal`)
get
/domains/{domain}/postmasterDonnées Google Postmaster Tools
Données Gmail publiées par Google Postmaster Tools pour le domaine, synchronisées chaque jour quand un administrateur a connecté un compte Google (page de l'organisation) : taux de spam signalé, authentification SPF, DKIM et DMARC, erreurs de livraison, conformité calculée par Google, réputation (meilleur effort). Tous les taux sont en pourcentage de 0 à 100. Google publie avec 1 à 2 jours de retard et seulement au-delà d'un volume quotidien suffisant vers Gmail. Sans connexion : `connected` = false et série vide. Paramètre `days` invalide : 400 (code `postmasterDaysInvalid`). Portée minimale : viewer.
Clé d'API requise.
Paramètres
domain (chemin, obligatoire) - Nom de domaine suivi par l'organisation (ex. exemple.ca).days (requête) - Période de la série : 7, 30 (défaut) ou 90 jours.
Réponses
200 Données Postmaster Tools400 Requête invalide (codes `invalidJson`, `invalidRequest`, `domainRequired`, `domainInvalid`, `apiSinceInvalid`...)401 Clé absente (`apiKeyMissing`) ou invalide, révoquée (`apiKeyInvalid`)402 Forfait insuffisant : API non comprise dans le forfait de l'organisation (`planFeatureApi`) ou limite de domaines atteinte (`planLimitDomains`, `POST /domains`)404 Ressource absente de l'organisation (`domainNotFound`, `scanNotFound`)429 Limite de débit atteinte (`tooManyRequests`)500 Erreur interne (`internal`)