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 i motori defender per 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 a scopo di manutenzione e per un periodo di tempo limitato e non deve essere usata invece di regole di esclusione degli avvisi. Usare questa API solo per operazioni di manutenzione temporanea monouso.
Corda. Definisce l'ID del ticket di manutenzione nei sistemi dell'utente. Assicurarsi che l'ID ticket non sia collegato a una finestra aperta esistente.
2987345p98234
Obbligatorio
ttl
Numero intero positivo. Definisce il TTL (durata), ovvero la durata della finestra di manutenzione, espressa in minuti. Al termine del periodo di tempo definito, la finestra di manutenzione è finita e il sistema si comporta di nuovo normalmente.
180
Obbligatorio
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 dalle appliance (Gestisci appliance del sensore OT) API.
1,35,63
Opzionale
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
Opzionale
Codice di stato
Messaggio
Descrizione
201 (creato)
-
L'azione è stata completata correttamente.
400 (richiesta non valida)
Nessun TicketId
Richiesta API mancante per un valore ticketId.
400 (richiesta non valida)
TTL non valido
La richiesta API includeva un valore TTL non positivo o non numerico.
400 (richiesta non valida)
Impossibile analizzare la richiesta.
Problema durante l'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 del ticket è collegato a un'altra finestra di manutenzione aperta.
Recuperare un log di tutte le aperte (POST), chiudere (DELETE) e aggiornare (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
Opzionale
toDate
Filtra i log fino alla data predefinita. Il formato è YYYY-MM-DD.
2022-08-10
Opzionale
ticketId
Filtra i log correlati a un ID ticket specifico.
9a5fe99c-d914-4bda-9332-307384fe40bf
Opzionale
tokenName
Filtra i log correlati a un nome di token specifico.
finestra trimestrale di integrità
Opzionale
codici di errore:
Codice
Messaggio
Descrizione
200
OK
L'azione è stata completata correttamente.
204:
Nessun contenuto
Non sono presenti dati da visualizzare.
400
Richiesta non valida
Il formato della data non è corretto.
500
Errore interno del server
Qualsiasi altro errore imprevisto.
tipo: JSON
Matrice di oggetti JSON che rappresentano le operazioni della finestra di manutenzione.
Struttura della risposta:
Nome
Digitare
Nullable/Not nullable
Elenco di valori
ID
Intero lungo
Non nullable
ID interno per il log corrente
dateTime
Corda
Non nullable
Ora in cui si è verificata l'attività, ad esempio: 2022-04-23T18:25:43.511Z
ticketId
Corda
Non nullable
ID finestra di manutenzione. Ad esempio: 9a5fe99c-d914-4bda-9332-307384fe40bf
tokenName
Corda
Non nullable
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 si applica la finestra di manutenzione, come specificato durante la creazione della finestra di manutenzione.
ttl
Numerico
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 parametro ttl. 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 desidera aggiungere altri 30 minuti, aggiornare il ttl a 120 minuto per reimpostare il conteggio della durata.