API de liste d'autorisation de domaines

Docs > Gestion de compte > API de liste d'autorisation de domaines

Commencer avec la liste d'autorisation de domaines

La liste d'autorisation de domaines est disponible pour les clients disposant d'un plan Enterprise. Si vous êtes intéressé par cette fonctionnalité, contactez l'assistance Datadog pour demander l'accès.

Request Access

La liste d’autorisation de domaines vous permet de restreindre les domaines de messagerie auxquels les notifications peuvent être envoyées.

Ce document décrit comment accéder à la liste d’autorisation de domaines et la configurer via l’API. Pour utiliser l’interface utilisateur à la place, consultez la liste d’autorisation de domaines.

Obtenir la liste d’autorisation de domaines

Renvoyez la liste d’autorisation de domaines et son état activé ou désactivé.

GET https://api.datadoghq.com/api/v2/domain_allowlist

Requête

Exemple

curl -X GET "https://api.datadoghq.com/api/v2/domain_allowlist" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Réponse

Modèle

Champ	Type	Rôle
données	objet	Données de messagerie de la liste d’autorisation de domaines
data.type	enum	Type de liste d’autorisation de domaines. Valeurs énumérées autorisées : `domain_allowlist`. Par défaut : `domain_allowlist`.
data.attributes	objet	Attributs de la liste d’autorisation de domaines
data.attributes.enabled	Booléen	Si `true`, la liste d’autorisation de domaines est activée
data.attributes.domains	[string]	Liste des domaines dans la liste d’autorisation de domaines

Forbidden

Modèle

Champ	Type	Rôle
errors [required]	[string]	Liste des erreurs

Not Found

Modèle

Champ	Type	Rôle
errors [required]	[string]	Liste des erreurs

Too many requests

Modèle

Champ	Type	Rôle
errors [required]	[string]	Liste des erreurs

Exemple

{
  "data": {
    "type": "domain_allowlist",
    "attributes": {
      "enabled": true,
      "domains": [
        "@aol.com",
        "@yahoo.com",
        "@gmail.com"
      ]
    }
  }
}

Modifier la liste d’autorisation d’un domaine

Activez ou désactivez la liste d’autorisation de domaines et réécrivez entièrement la liste avec une liste donnée de domaines de messagerie.

PATCH https://api.datadoghq.com/api/v2/domain_allowlist

Requête

Exemple

curl -X PATCH "https://api.datadog.com/api/v2/domain_allowlist" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF

{
  "data": {
    "type": "domain_allowlist",
    "attributes": {
      "enabled": true,
      "domains": [
        "@datadoghq.com",
        "@yahoo.com",
        "@gmail.com"
      ]
    }
  }
}

EOF

Réponse

Modèle

Champ	Type	Rôle
données	objet	Données de messagerie de la liste d’autorisation de domaines
data.type	enum	Type de liste d’autorisation de domaines. Valeurs énumérées autorisées : `domain_allowlist`. Par défaut : `domain_allowlist`.
data.attributes	objet	Attributs de la liste d’autorisation de domaines
data.attributes.enabled	Booléen	Si `true`, la liste d’autorisation de domaines est activée
data.attributes.domains	[string]	Liste des domaines dans la liste d’autorisation de domaines

Forbidden

Modèle

Champ	Type	Rôle
errors [required]	[string]	Liste des erreurs

Not Found

Modèle

Champ	Type	Rôle
errors [required]	[string]	Liste des erreurs

Too many requests

Modèle

Champ	Type	Rôle
errors [required]	[string]	Liste des erreurs

Exemple

{
  "data": {
    "type": "domain_allowlist",
    "attributes": {
      "enabled": true,
      "domains": [
        "@datadoghq.com",
        "@yahoo.com",
        "@gmail.com"
      ]
    }
  }
}