API de machine hors-bord
S’applique à :
- Microsoft Defender pour point de terminaison Plan 1
- Microsoft Defender pour point de terminaison
- Microsoft Defender XDR
Vous voulez découvrir 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
Désintégez l’appareil de Defender pour point de terminaison.
Limitations
Les limitations de débit pour cette API sont de 100 appels par minute et de 1 500 appels par heure.
Remarque
Cette page se concentre sur l’exécution d’une action de machine via l’API. Pour plus d’informations sur la fonctionnalité des actions de réponse via Microsoft Defender pour point de terminaison, consultez Effectuer des actions de réponse sur un ordinateur .
Remarque
- Cette API est prise en charge sur Windows 11, Windows 10, version 1703 et versions ultérieures ; sur Windows Server 2019 et versions ultérieures ; et sur Windows Server 2012 R2 et Windows Server 2016 lors de l’utilisation du nouvel agent unifié pour Defender pour point de terminaison.
- Cette API n’est pas prise en charge sur les appareils macOS ou Linux.
- L’exécution de l’API de désintégrage arrête uniquement l’exécution du service de capteur, mais elle ne supprime pas les informations d’intégration du Registre comme le fait un script de désintégrage.
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 Defender pour point de terminaison.
| Type d’autorisation | Autorisation | Nom complet de l’autorisation |
|---|---|---|
| Application | Machine.Offboard |
Offboard machine |
| Déléguée (compte professionnel ou scolaire) | Machine.Offboard |
Offboard machine |
Importante
Microsoft vous recommande d’utiliser des rôles disposant du moins d’autorisations. Cela contribue à renforcer la sécurité de votre organisation. Le rôle d’administrateur général dispose de privilèges élevés. Il doit être limité aux scénarios d’urgence lorsque vous ne pouvez pas utiliser un rôle existant.
Remarque
Lors de l’obtention d’un jeton à l’aide des informations d’identification de l’utilisateur :
- L’utilisateur doit avoir un rôle d’administrateur général.
- L’utilisateur doit avoir accès à l’appareil, 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 dans Defender pour point de terminaison Plan 1 et Plan 2.
Requête HTTP
POST https://api.security.microsoft.com/api/machines/{id}/offboard
L’ID de machine se trouve dans l’URL lorsque vous sélectionnez l’appareil. En règle générale, il s’agit d’un nombre alphanumérique à 40 chiffres qui se trouve dans l’URL.
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 un objet JSON avec les paramètres suivants :
| Paramètre | Type | Description |
|---|---|---|
| Commentaire | Chaîne | Commentaire à associer à l’action. Obligatoire. |
Réponse
Si elle réussit, cette méthode retourne 200 - Created response le code et l’action machine dans le corps de la réponse.
Exemple
Demande
Voici un exemple de demande. Si aucun commentaire JSON n’est ajouté, il génère une erreur avec le code 400.
POST https://api.security.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/offboard
{
"Comment": "Offboard machine by automation"
}
Conseil
Voulez-vous en savoir plus ? Collaborez avec la communauté Microsoft Security dans notre communauté technique : Microsoft Defender pour point de terminaison Tech Community.