API de máquina fuera del panel
Se aplica a:
- Microsoft Defender para punto de conexión Plan 1
- Microsoft Defender para punto de conexión
- Microsoft Defender XDR
¿Quiere experimentar Defender para punto de conexión? Regístrese para obtener una prueba gratuita.
Nota:
Si es un cliente del Gobierno de EE. UU., use los URI que aparecen en Microsoft Defender para punto de conexión para clientes del Gobierno de EE. UU.
Sugerencia
Para mejorar el rendimiento, puede usar el servidor más cercano a la ubicación geográfica:
- 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
Descripción de la API
Dispositivo fuera del panel de Defender para punto de conexión.
Limitaciones
Las limitaciones de velocidad de esta API son 100 llamadas por minuto y 1500 llamadas por hora.
Nota:
Esta página se centra en realizar una acción de máquina a través de la API. Consulte Realizar acciones de respuesta en una máquina para obtener más información sobre la funcionalidad de acciones de respuesta a través de Microsoft Defender para punto de conexión.
Nota:
- Esta API es compatible con Windows 11, Windows 10, versión 1703 y versiones posteriores; en Windows Server 2019 y versiones posteriores; y en Windows Server 2012 R2 y Windows Server 2016 cuando se usa el nuevo agente unificado para Defender para punto de conexión.
- Esta API no se admite en dispositivos macOS o Linux.
- La ejecución de la API de offboarding solo impide que el servicio de sensor se ejecute, pero no quita la información de incorporación del registro como lo hace un script de offboarding.
Permisos
Se requiere uno de los siguientes permisos para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, consulte Uso de Defender para API de punto de conexión.
Tipo de permiso | Permiso | Nombre para mostrar del permiso |
---|---|---|
Aplicación | Machine.Offboard |
Offboard machine |
Delegado (cuenta profesional o educativa) | Machine.Offboard |
Offboard machine |
Importante
Microsoft recomienda utilizar roles con la menor cantidad de permisos. Esto ayuda a mejorar la seguridad de la organización. Administrador global es un rol con muchos privilegios que debe limitarse a escenarios de emergencia cuando no se puede usar un rol existente.
Nota:
Al obtener un token con credenciales de usuario:
- El usuario debe tener un rol de administrador global.
- El usuario debe tener acceso al dispositivo, en función de la configuración del grupo de dispositivos. Para obtener más información, consulte Creación y administración de grupos de dispositivos.
La creación de grupos de dispositivos se admite en El plan 1 y el plan 2 de Defender para punto de conexión.
Solicitud HTTP
POST https://api.security.microsoft.com/api/machines/{id}/offboard
El identificador de equipo se puede encontrar en la dirección URL al seleccionar el dispositivo. Por lo general, es un número alfanumérico de 40 dígitos que se puede encontrar en la dirección URL.
Encabezados de solicitud
Nombre | Tipo | Descripción |
---|---|---|
Authorization | Cadena | {token} de portador. Necesario. |
Content-Type | string | application/json. Necesario. |
Cuerpo de la solicitud
En el cuerpo de la solicitud, proporcione un objeto JSON con los parámetros siguientes:
Parámetro | Tipo | Descripción |
---|---|---|
Comentario | Cadena | Comentario que se va a asociar a la acción. Necesario. |
Respuesta
Si se ejecuta correctamente, este método devuelve 200 - Created response
código y Acción de máquina en el cuerpo de la respuesta.
Ejemplo
Solicitud
Este es un ejemplo de la solicitud. Si no se agrega ningún comentario JSON, se produce un error con el código 400
.
POST https://api.security.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/offboard
{
"Comment": "Offboard machine by automation"
}
Sugerencia
¿Desea obtener más información? Interactúe con la comunidad de seguridad de Microsoft en nuestra comunidad tecnológica: Microsoft Defender para punto de conexión Tech Community.