Gestisce le finestre di manutenzione, in cui gli avvisi non verranno inviati. Usare questa API per definire e aggiornare orari di arresto e avvio, dispositivi o subnet che devono essere esclusi durante l'attivazione di avvisi o definire e aggiornare Defender per i motori IoT che devono essere esclusi.
Ad esempio, durante una finestra di manutenzione, è possibile interrompere il recapito degli avvisi di tutti gli avvisi, ad eccezione degli avvisi malware nei dispositivi critici.
Le finestre di manutenzione che definiscono con l'API maintenanceWindow vengono visualizzate nella finestra Esclusioni avvisi della console di gestione locale come regola di esclusione di sola lettura, denominata con la sintassi seguente: Maintenance-{token name}-{ticket ID}.
Importante
Questa API è supportata solo per scopi di manutenzione e per un periodo di tempo limitato e non deve essere usata anziché regole di esclusione degli avvisi. Usare questa API solo per operazioni di manutenzione temporanea una sola volta.
Stringa. Definisce l'ID del ticket di manutenzione nei sistemi dell'utente. Assicurarsi che l'ID del ticket non sia collegato a una finestra aperta esistente.
2987345p98234
Necessario
Ttl
Intero positivo. Definisce il TTL (tempo da vivere), ovvero la durata della finestra di manutenzione, in minuti. Al termine del periodo di tempo definito, la finestra di manutenzione è finita e il sistema si comporta normalmente.
180
Necessario
Motori
Matrice JSON di stringhe. Definisce il motore da cui eliminare gli avvisi durante la finestra di manutenzione. Valori possibili:
Matrice JSON di stringhe. Definisce i sensori da cui eliminare gli avvisi durante la finestra di manutenzione. È possibile ottenere questi ID sensore dall'API Gestisci appliance del sensore OT .
1,35,63
Facoltativo
Subnet
Matrice JSON di stringhe. Definisce le subnet da cui eliminare gli avvisi durante la finestra di manutenzione. Definire ogni subnet in una notazione CIDR.
192.168.0.0/16,138.136.80.0/14,112.138.10.0/8
Facoltativo
Codice di stato
Message
Descrizione
201 (Creato) oppure
-
L'azione è stata completata correttamente.
400 (richiesta non valida)
Nessun ticketId
La richiesta API mancava un ticketId valore.
400 (richiesta non valida)
TTL illegale
La richiesta API includeva un valore TTL non positivo o non numerico.
400 (richiesta non valida)
Impossibile analizzare la richiesta.
Problema di analisi del corpo, ad esempio parametri non corretti o valori non validi.
400 (richiesta non valida)
La finestra di manutenzione con gli stessi parametri esiste già.
Viene visualizzato quando esiste già una finestra di manutenzione esistente con gli stessi dettagli.
404 (non trovato)
ID sensore sconosciuto
Uno dei sensori elencati nella richiesta non esiste.
409 (conflitto)
L'ID ticket ha già una finestra aperta.
L'ID ticket è collegato a un'altra finestra di manutenzione aperta.
Recuperare un log di tutte le azioni aperte (POST), close (DELETE) e update (PUT) eseguite usando questa API per la gestione delle finestre di manutenzione. T
Filtra i log dalla data predefinita e versioni successive. Il formato è YYYY-MM-DD.
2022-08-10
Facoltativo
Todate
Filtra i log fino alla data predefinita. Il formato è YYYY-MM-DD.
2022-08-10
Facoltativo
ticketId
Filtra i log correlati a un ID ticket specifico.
9a5fe99c-d914-4bda-9332-307384fe40bf
Facoltativo
tokenName
Filtra i log correlati a un nome di token specifico.
finestra trimestrale di integrità
Facoltativo
Codici di errore:
Codice
Message
Descrizione
200
OK
L'azione è stata completata correttamente.
204:
Nessun contenuto
Non sono presenti dati da visualizzare.
400
Bad Request
Il formato della data non è corretto.
500
Internal Server Error
Qualsiasi altro errore imprevisto.
Tipo: JSON
Matrice di oggetti JSON che rappresentano le operazioni della finestra di manutenzione.
Struttura della risposta:
Nome
Tipo
Nullable/Not nullable
Elenco di valori
id
Long integer
Non ammette valori Null.
ID interno per il log corrente
dateTime
string
Non ammette valori Null.
Ora in cui si è verificata l'attività, ad esempio: 2022-04-23T18:25:43.511Z
ticketId
string
Non ammette valori Null.
ID finestra di manutenzione. ad esempio 9a5fe99c-d914-4bda-9332-307384fe40bf
tokenName
string
Non ammette valori Null.
Nome del token della finestra di manutenzione. ad esempio quarterly-sanity-window
Motori
Matrice di stringhe
Nullable
Motori su cui si applica la finestra di manutenzione, come specificato durante la creazione della finestra di manutenzione: Protocol Violation, Policy Violation, Malware, Anomalyo Operational
sensorIds
Matrice di stringhe
Nullable
Sensori su cui si applica la finestra di manutenzione, come specificato durante la creazione della finestra di manutenzione.
Subnet
Matrice di stringhe
Nullable
Subnet in cui viene applicata la finestra di manutenzione, come specificato durante la creazione della finestra di manutenzione.
Ttl
Numeric
Nullable
Durata (TTL) della finestra di manutenzione, come specificato durante la creazione o l'aggiornamento della finestra di manutenzione.
Consente di aggiornare la durata della finestra di manutenzione dopo l'avvio del processo di manutenzione modificando il ttl parametro . La nuova definizione di durata sostituisce quella precedente.
Questo metodo è utile quando si desidera impostare una durata più lunga rispetto alla durata attualmente configurata. Ad esempio, se sono stati originariamente definiti 180 minuti, sono trascorsi 90 minuti e si vuole aggiungere altri 30 minuti, aggiornare al ttl120 minuto per reimpostare il conteggio della durata.