Administra las ventanas de mantenimiento, en las que no se enviarán alertas. Use esta API para definir y actualizar las horas de inicio y detención, los dispositivos o subredes que se deben excluir al desencadenar las alertas o defina y actualice los motores de Defender para IoT que deben excluirse.
Por ejemplo, durante una ventana de mantenimiento, quizá quiera detener la entrega de alertas para todas las alertas, salvo las alertas de malware en dispositivos críticos.
Las ventanas de mantenimiento que se definen con la API maintenanceWindow aparecen en la ventana Exclusiones de alertas de la consola de administración local como una regla de exclusión de solo lectura, denominada con la siguiente sintaxis: Maintenance-{token name}-{ticket ID}.
Importante
Esta API solo se admite con fines de mantenimiento y durante un tiempo limitado, y no está pensada para usarse en lugar de las reglas de exclusión de alertas. Use esta API solo para las operaciones de mantenimiento puntuales y temporales.
Cadena define el id. del vale de mantenimiento en los sistemas del usuario. Asegúrese de que el id. de vale no está vinculado a una ventana abierta existente.
2987345p98234
Obligatorio
ttl
Entero positivo. Define el TTL (período de vida), que es la duración de la ventana de mantenimiento en minutos. Una vez completado el período de tiempo definido, la ventana de mantenimiento finaliza el sistema vuelve a comportarse de manera normal.
180
Obligatorio
engines
Matriz JSON de cadenas. Define de qué motor se van a suprimir las alertas durante la ventana de mantenimiento. Valores posibles:
Matriz JSON de cadenas. Define de qué sensores se van a suprimir las alertas durante la ventana de mantenimiento. Puede obtener estos identificadores de sensor desde la API de dispositivos (administrar dispositivos de sensor de OT).
1,35,63
Opcionales
subredes
Matriz JSON de cadenas. Define de qué subredes se van a suprimir las alertas durante la ventana de mantenimiento. Defina cada subred en una notación CIDR.
192.168.0.0/16,138.136.80.0/14,112.138.10.0/8
Opcional
status code
Message
Descripción
201 (creado)
-
la acción se ha completado correctamente.
400 (Solicitud incorrecta)
No TicketId
Faltaba un valor ticketId en la solicitud de API.
400 (Solicitud incorrecta)
TTL ilegal
La solicitud de API incluía un valor TTL no positivo o no numérico.
400 (Solicitud incorrecta)
No se pudo analizar la solicitud.
Problema al analizar el cuerpo, como parámetros incorrectos o valores no válidos.
400 (Solicitud incorrecta)
Ya existe una ventana de mantenimiento con los mismos parámetros.
Aparece cuando ya existe una ventana de mantenimiento con los mismos detalles.
404 (No encontrado)
Identificador de sensor desconocido
Uno de los sensores enumerados en la solicitud no existe.
409 (Conflicto)
El identificador de vale ya tiene una ventana abierta.
el id. de vale está vinculado a otra ventana de mantenimiento abierta.
Recupere un registro de todas las acciones abrir (POST), cerrar (DELETE) y actualizar (PUT) que se realizaron mediante esta API para controlar las ventanas de mantenimiento. T
filtra los registros de la fecha predefinida y posteriores. El formato es YYYY-MM-DD.
2022-08-10
Opcionales
toDate
filtra los registros hasta la fecha predefinida. El formato es YYYY-MM-DD.
2022-08-10
Opcionales
ticketId
filtra los registros relacionados con un id. de vale específico.
9a5fe99c-d914-4bda-9332-307384fe40bf
Opcionales
tokenName
filtra los registros relacionados con un token específico.
quarterly-sanity-window
Opcionales
Códigos de error:
Código
Message
Descripción
200
Aceptar
la acción se ha completado correctamente.
204:
Ningún contenido
no hay ningún dato que mostrar.
400
Bad Request
El formato de fecha es incorrecto.
500
Internal Server Error
cualquier otro error inesperado.
Tipo: JSON
Matriz de objetos JSON que representan a las operaciones de la ventana de mantenimiento.
Estructura de la respuesta:
Nombre
Tipo
Que admite valores NULL / No admite valores NULL
Lista de valores
id
Entero largo
No acepta valores NULL
Un identificador interno para el registro actual
dateTime
String
No acepta valores NULL
Hora a la que se produjo la actividad, por ejemplo: 2022-04-23T18:25:43.511Z
ticketId
String
No acepta valores NULL
Identificador de la ventana de mantenimiento. Por ejemplo: 9a5fe99c-d914-4bda-9332-307384fe40bf
tokenName
String
No acepta valores NULL
Nombre del token de la ventana de mantenimiento. Por ejemplo: quarterly-sanity-window
engines
Matriz de cadenas
Nullable
Motores en los que se aplica la ventana de mantenimiento, tal como se proporciona durante la creación de la ventana de mantenimiento: Protocol Violation, Policy Violation, Malware, Anomaly o Operational
sensorIds
Matriz de cadena
Nullable
Sensores en los que se aplica la ventana de mantenimiento, tal como se proporciona durante la creación de la ventana de mantenimiento.
subredes
Matriz de cadena
Nullable
Subredes en las que se aplica la ventana de mantenimiento, tal como se proporciona durante la creación de la ventana de mantenimiento.
ttl
Numeric
Nullable
Período de vida (TTL) de la ventana de mantenimiento, tal y como se proporciona durante la creación o actualización de la ventana de mantenimiento.
operationType
String
No acepta valores NULL
Uno de los valores siguientes: OPEN, UPDATE y CLOSE
Permite actualizar la duración de la ventana de mantenimiento después de iniciar el proceso de mantenimiento al cambiar el parámetro ttl. La nueva definición de duración invalida a la anterior.
Este método resulta útil cuando se quiere establecer una duración más larga que la duración configurada actualmente. Por ejemplo, si ha definido originalmente 180 minutos, han transcurrido 90 minutos y desea agregar otros 30 minutos, actualice el minuto ttl a 120 para restablecer el recuento de duración.