Créer une API d’alerte

Article
07/04/2024

S’applique à :

Vous voulez découvrir Microsoft Defender pour point de terminaison ? Inscrivez-vous pour bénéficier d’un essai gratuit.

Remarque

Si vous êtes un client du gouvernement des États-Unis, utilisez les URI répertoriés dans Microsoft Defender pour point de terminaison pour les clients du gouvernement des États-Unis.

Conseil

Pour de meilleures performances, vous pouvez utiliser le serveur plus près de votre emplacement géographique :

us.api.security.microsoft.com
eu.api.security.microsoft.com
uk.api.security.microsoft.com
au.api.security.microsoft.com
swa.api.security.microsoft.com
ina.api.security.microsoft.com

Description de l’API

Crée une alerte par-dessus l’événement.

L’événement Microsoft Defender pour point de terminaison est requis pour la création de l’alerte.
Vous devez fournir trois paramètres à partir de l’événement dans la requête : Heure de l’événement, ID de machine et ID de rapport. Voir l’exemple ci-dessous.
Vous pouvez utiliser un événement trouvé dans l’API de chasse avancée ou le portail.
S’il existe une alerte ouverte sur le même appareil avec le même titre, la nouvelle alerte créée est fusionnée avec celle-ci.
Une investigation automatique démarre automatiquement sur les alertes créées via l’API.

Limitations

Les limitations de débit pour cette API sont de 15 appels par minute.

Autorisations

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour en savoir plus, notamment sur le choix des autorisations, consultez Utiliser les API Microsoft Defender pour point de terminaison.

Type d’autorisation	Autorisation	Nom complet de l’autorisation
Application	Alert.ReadWrite.All	« Lire et écrire toutes les alertes »
Déléguée (compte professionnel ou scolaire)	Alert.ReadWrite	« Lire et écrire des alertes »

Remarque

Lors de l’obtention d’un jeton à l’aide des informations d’identification de l’utilisateur :

L’utilisateur doit disposer au moins de l’autorisation de rôle suivante : Investigation des alertes. Pour plus d’informations, consultez Créer et gérer des rôles.
L’utilisateur doit avoir accès à l’appareil associé à l’alerte, en fonction des paramètres du groupe d’appareils. Pour plus d’informations, consultez Créer et gérer des groupes d’appareils.

La création de groupes d’appareils est prise en charge à la fois dans Defender pour point de terminaison Plan 1 et Plan 2

Requête HTTP

POST https://api.securitycenter.microsoft.com/api/alerts/CreateAlertByReference

En-têtes de demande

Nom	Type	Description
Autorisation	Chaîne	Porteur {token}. Obligatoire.
Content-Type	String	application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez les valeurs suivantes (toutes sont requises) :

Propriété	Type	Description
eventTime	DateTime(UTC)	Heure précise de l’événement sous forme de chaîne, obtenue à partir de la chasse avancée. Par exemple, `2018-08-03T16:45:21.7115183Z`Obligatoire.
reportId	Chaîne	ReportId de l’événement, tel qu’obtenu à partir de la chasse avancée. Obligatoire.
machineId	Chaîne	ID de l’appareil sur lequel l’événement a été identifié. Obligatoire.
Sévérité	Chaîne	Gravité de l’alerte. Les valeurs de la propriété sont « Low », « Medium » et « High ». Obligatoire.
title	Chaîne	Titre de l’alerte. Obligatoire.
description	Chaîne	Description de l’alerte. Obligatoire.
recommendedAction	Chaîne	L’agent de sécurité doit effectuer cette action lors de l’analyse de l’alerte. Obligatoire.
category	String	Catégorie de l’alerte. Les valeurs de propriété sont : « General », « CommandAndControl », « Collection », « CredentialAccess », « DefenseEvasion », « Discovery », « Exfiltration », « Exploit », « Execution », « InitialAccess », « LateralMovement », « Malware », « Persistence », « PrivilegeEscalation », « Ransomware », « SuspiciousActivity » Obligatoire.

Réponse

Si elle réussit, cette méthode renvoie 200 OK et un nouvel objet d’alerte dans le corps de la réponse. Si l’événement avec les propriétés spécifiées (reportId, eventTime et machineId) est introuvable , 404 Introuvable.

Exemple

Demande

Voici un exemple de demande.

POST https://api.securitycenter.microsoft.com/api/alerts/CreateAlertByReference

{
    "machineId": "1e5bc9d7e413ddd7902c2932e418702b84d0cc07",
    "severity": "Low",
    "title": "example",
    "description": "example alert",
    "recommendedAction": "nothing",
    "eventTime": "2018-08-03T16:45:21.7115183Z",
    "reportId": "20776",
    "category": "Exploit"
}