Verifica (server di pubblicazione indipendente) (anteprima)

Checkly è la piattaforma di monitoraggio per lo stack moderno: programmabile, flessibile e amore per JavaScript. Monitorare e convalidare le transazioni del sito cruciali. Raccogliere automaticamente tracce di errore, screenshot e metriche delle prestazioni con ogni verifica eseguita.

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

Servizio	Class	Regions
Copilot Studio	Di alta qualità	Tutte le aree di Power Automate , ad eccezione delle seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)
App per la logica	Normale	Tutte le aree di App per la logica , ad eccezione delle seguenti:      - Aree di Azure per enti pubblici      - Aree di Azure Cina      - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Apps	Di alta qualità	Tutte le aree di Power Apps , ad eccezione dei seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Automate	Di alta qualità	Tutte le aree di Power Automate , ad eccezione delle seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)

Contatto
Nome	Troy Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Metadati del connettore
Editore	Troy Taylor
Sito web	https://www.checklyhq.com/
Informativa sulla privacy	https://www.checklyhq.com/privacy
Categorie	Operazioni IT

Creazione di una connessione

Il connettore supporta i tipi di autenticazione seguenti:

Predefinita	Parametri per la creazione della connessione.	Tutte le aree geografiche	Non condivisibile

Predefinito

Applicabile: tutte le aree

Parametri per la creazione della connessione.

Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.

Nome	TIPO	Description	Obbligatorio
Account ID	securestring	ID account per questa API.	Vero
Chiave API (nel formato 'Bearer apiKey')	securestring	Chiave API (nel formato "Bearer apiKey") per questa API	Vero

Limiti per la limitazione delle richieste

Nome	Chiamate	Periodo di rinnovo
Chiamate API per connessione	100	60 secondi

Azioni

Aggiornare le sottoscrizioni di un canale di avviso	Aggiornare le sottoscrizioni di un canale di avviso. Usare questa opzione per aggiungere un controllo a un canale di avviso in modo che gli avvisi di errore e ripristino vengano inviati per tale controllo. Nota: quando si passa l'oggetto sottoscrizione, è possibile specificare solo un checkId o un groupId, non entrambi.
Aggiornare un canale di avviso	Aggiornare un canale di avviso.
Aggiornare un controllo [DEPRECATO]	[DEPRECATO] Questo endpoint verrà rimosso il 4 luglio 2022. Usare invece PUT /checks/api/{id} o PUT /checks/browser/{id}. Aggiorna una nuova API o un controllo del browser.
Aggiornare un controllo API	Aggiorna un controllo API.
Aggiornare un controllo del browser	Aggiorna un controllo del browser.
Aggiornare un dashboard	Aggiorna un dashboard. Restituisce un valore 409 quando si tenta di creare un dashboard con un URL personalizzato o un dominio personalizzato già acquisito.
Aggiornare un frammento di codice	Aggiorna un frammento di codice.
Aggiornare un gruppo di controllo	Aggiorna un gruppo di controllo.
Aggiornare una finestra di manutenzione	Aggiorna una finestra di manutenzione.
Aggiornare una posizione privata	Aggiorna una posizione privata.
Aggiornare una variabile di ambiente	Aggiorna una variabile di ambiente. Usa il campo chiave come identificatore per l'aggiornamento. Aggiorna solo il valore e la proprietà bloccata.
Creare il trigger check	Crea il trigger check.
Creare il trigger del gruppo di controllo	Crea il trigger del gruppo di controllo.
Creare un canale di avviso	Crea un nuovo canale di avviso.
Creare un controllo [DEPRECATO]	[DEPRECATO] Questo endpoint verrà rimosso il 4 luglio 2022. Usare invece POST /checks/api o POST /checks/browser. Crea una nuova API o un controllo del browser. Restituisce un valore 402 quando si supera il limite del piano. Quando si usa globalAlertSettings, può alertSettings essere null
Creare un controllo API	Crea un nuovo controllo API. Restituisce un valore 402 quando si supera il limite del piano. Quando si usa globalAlertSetting, può alertSetting essere null
Creare un controllo del browser	Crea un nuovo controllo del browser. Restituisce un valore 402 quando si supera il limite del piano. Quando si usa globalAlertSetting, può alertSetting essere null
Creare un dashboard	Crea un nuovo dashboard. Restituisce un valore 409 quando si tenta di creare un dashboard con un URL personalizzato o un dominio personalizzato già acquisito.
Creare un frammento di codice	Crea un nuovo frammento di codice.
Creare un gruppo di controllo	Crea un nuovo gruppo di controlli. È possibile aggiungere controlli al gruppo impostando la proprietà groupId dei singoli controlli.
Creare una finestra di manutenzione	Crea una nuova finestra di manutenzione.
Creare una posizione privata	Crea una nuova posizione privata.
Creare una variabile di ambiente	Crea una nuova variabile di ambiente.
Elenca tutte le posizioni supportate	Elenca tutte le posizioni supportate.
Elenca tutti i risultati dei controlli	Elenca i risultati completi del controllo non elaborato per un controllo specifico. I risultati non elaborati vengono mantenuto per 30 giorni. Dopo 30 giorni vengono cancellati. Tuttavia, si mantengono i risultati di rollup per un periodo indefinito. È possibile filtrare in base al tipo di controllo e al tipo di risultato per restringere l'elenco. Usare i to parametri e from per specificare un intervallo di date (timestamp UNIX in secondi). A seconda del tipo di controllo, alcuni campi potrebbero essere Null. Questo endpoint restituirà i dati entro un intervallo di sei ore. Se vengono impostati parametri da e a , devono essere al massimo sei ore di distanza. Se nessuno è impostato, si considererà il parametro per essere ora e dal parametro a sei ore prima. Se viene impostata solo la proprietà da a param, verrà impostata da a essere sei ore prima. Al contrario, se viene impostato solo il parametro da param, si considererà il parametro per essere sei ore dopo. La limitazione della frequenza viene applicata a questo endpoint, è possibile inviare al massimo 5 richieste/10 secondi.
Elenca tutti i runtime supportati	Elenca tutti i runtime supportati e i pacchetti NPM inclusi per i controlli del browser e gli script di installazione e disinstallazione per i controlli API.
Elencare gli avvisi per un controllo specifico	Elenca tutti gli avvisi per un controllo specifico.
Elencare tutte le finestre di manutenzione	Elenca tutte le finestre di manutenzione nell'account.
Elencare tutte le posizioni private	Elenca tutte le posizioni private nell'account.
Elencare tutte le variabili di ambiente	Elenca tutte le variabili di ambiente correnti nell'account.
Elencare tutti gli avvisi per l'account	Elenca tutti gli avvisi per l'account.
Elencare tutti gli stati di controllo	Mostra le informazioni sullo stato correnti per tutti i controlli nell'account. I record di stato del controllo vengono aggiornati continuamente man mano che vengono visualizzati i nuovi risultati del controllo.
Elencare tutti i canali di avviso	Elenca tutti i canali di avviso configurati e i relativi controlli sottoscritti.
Elencare tutti i controlli	Elenca tutti i controlli correnti nel tuo account.
Elencare tutti i dashboard	Elenca tutti i dashboard correnti nell'account.
Elencare tutti i frammenti di codice	Elenca tutti i frammenti di codice correnti nell'account.
Elencare tutti i gruppi di controllo	Elenca tutti i gruppi di controllo correnti nell'account. La proprietà checks è una matrice di controlli UUID per un riferimento pratico. È di sola lettura e non è possibile usarlo per aggiungere controlli a un gruppo.
Eliminare il trigger check	Elimina il trigger check.
Eliminare il trigger del gruppo di controllo	Elimina il trigger check groups.
Eliminare un canale di avviso	Rimuove definitivamente un canale di avviso.
Eliminare un controllo	Rimuove definitivamente un'API o un controllo del browser e tutti i relativi dati sullo stato e sui risultati correlati.
Eliminare un dashboard	Rimuove definitivamente un dashboard.
Eliminare un frammento di codice	Rimuove definitivamente un frammento di codice.
Eliminare un gruppo di controllo	Rimuove definitivamente un gruppo di controlli. Non è possibile eliminare un gruppo di controllo se contiene ancora controlli.
Eliminare una finestra di manutenzione	Rimuove definitivamente una finestra di manutenzione.
Eliminare una variabile di ambiente	Rimuove definitivamente una variabile di ambiente. Usa il campo chiave come identificatore per l'eliminazione.
Genera un report con statistiche di aggregazione per i controlli e i gruppi di controllo	Genera un report con statistiche aggregate per tutti i controlli o un set filtrato di controlli in un intervallo di tempo specificato.
Genera un report personalizzabile per tutte le metriche di controllo del browser	Genera un report con statistiche aggregate o non aggregate per un controllo browser specifico in un intervallo di tempo specificato.
Generare una nuova chiave API per una posizione privata	Crea una chiave API nella posizione privata.
Mostra i dettagli per un runtime specifico	Mostra i dettagli di tutti i pacchetti NPM inclusi e la relativa versione per un runtime specifico.
Notifica di stato del gruppo	Ottenere il badge di stato del gruppo.
Ottenere il badge di stato del controllo	Ottenere il badge di stato del controllo.
Ottenere il trigger check	Trova il trigger check.
Ottenere il trigger del gruppo di controllo	Trova il trigger del gruppo di controllo.
Ottenere le metriche di integrità della posizione privata da un intervallo di tempo	Ottenere le metriche di integrità della posizione privata da un intervallo di tempo.
Recuperare i dettagli dello stato di controllo	Mostra le informazioni sullo stato correnti per un controllo specifico.
Recuperare tutti i controlli in un gruppo specifico con le impostazioni di gruppo applicate	Elenca tutti i controlli in un gruppo di controllo specifico con le impostazioni di gruppo applicate.
Recuperare un'archiviazione in un gruppo specifico con le impostazioni di gruppo applicate	Mostra i dettagli di un controllo in un gruppo di controllo specifico con le impostazioni del gruppo applicate.
Recuperare un canale di avviso	Mostra i dettagli di un canale di avviso specifico.
Recuperare un controllo	Mostra i dettagli di un'API o di un controllo del browser specifico.
Recuperare un frammento di codice	Mostra i dettagli di un frammento specifico.
Recuperare un gruppo di controllo	Mostra i dettagli di un gruppo di controllo specifico.
Recuperare un risultato del controllo	Mostra i dettagli di un risultato di controllo specifico.
Recuperare una finestra di manutenzione	Mostra i dettagli di una finestra di manutenzione specifica.
Recuperare una posizione privata	Mostra i dettagli di una posizione privata specifica.
Recuperare una variabile di ambiente	Mostra i dettagli di una variabile di ambiente specifica. Usa il campo chiave per la selezione.
Rimuovere una chiave API esistente per una posizione privata	Rimuove definitivamente una chiave API da una posizione privata.
Rimuovere una posizione privata	Rimuove definitivamente una posizione privata.

Aggiornare le sottoscrizioni di un canale di avviso

ID operazione:

PutV1AlertchannelsIdSubscriptions

Aggiornare le sottoscrizioni di un canale di avviso. Usare questa opzione per aggiungere un controllo a un canale di avviso in modo che gli avvisi di errore e ripristino vengano inviati per tale controllo. Nota: quando si passa l'oggetto sottoscrizione, è possibile specificare solo un checkId o un groupId, non entrambi.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	integer	Identificatore.
Controllare l'ID	checkId		guid	È possibile passare un checkId o un groupId, ma non entrambi.
ID del Gruppo	groupId		number	È possibile passare un checkId o un groupId, ma non entrambi.
Attivato	activated	True	boolean	Se attivato.

Restituisce

Corpo

AlertChanelSubscription

Aggiornare un canale di avviso

ID operazione:

PutV1AlertchannelsId

Aggiornare un canale di avviso.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	integer	Identificatore.
Documento d'identità	id		number	Identificatore.
Controllare l'ID	checkId		guid	Identificatore di controllo.
ID del Gruppo	groupId		number	Identificatore del gruppo.
Attivato	activated	True	boolean	Se attivato.
TIPO	type	True	string	Tipo.
Creazione di una configurazione del canale di avviso	config	True	object	Configurazione di creazione del canale di avviso.
Invia ripristino	sendRecovery		boolean	Indica se inviare il ripristino.
Errore di invio	sendFailure		boolean	Indica se l'errore di invio.
Invio danneggiato	sendDegraded		boolean	Indica se l'invio è danneggiato.
Scadenza SSL	sslExpiry		boolean	Determina se un avviso deve essere inviato per i certificati SSL in scadenza.
Soglia di scadenza SSL	sslExpiryThreshold		integer	In quale momento iniziare a inviare avvisi sui certificati SSL.

Restituisce

Corpo

AlertChannel

Aggiornare un controllo [DEPRECATO]

ID operazione:

PutV1ChecksId

[DEPRECATO] Questo endpoint verrà rimosso il 4 luglio 2022. Usare invece PUT /checks/api/{id} o PUT /checks/browser/{id}. Aggiorna una nuova API o un controllo del browser.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	string	Identificatore.
Assegnazione automatica avvisi	autoAssignAlerts		boolean	Determina se un nuovo controllo verrà aggiunto automaticamente come sottoscrittore a tutti i canali di avviso esistenti al momento della creazione.
Nome	name		string	Nome del controllo.
Attivato	activated		boolean	Determina se il controllo è in esecuzione o meno.
Disattivato	muted		boolean	Determina se le notifiche verranno inviate quando un controllo ha esito negativo e/o viene ripristinato.
Verifica doppia	doubleCheck		boolean	L'impostazione di questa proprietà su true attiverà un nuovo tentativo quando un controllo non riesce dall'area non riuscita e un'altra area selezionata in modo casuale prima di contrassegnare il controllo come non riuscito.
Dovrebbe avere esito negativo	shouldFail		boolean	Consente di invertire il comportamento di quando un controllo viene considerato non riuscita. Consente di convalidare lo stato di errore, ad esempio 404.
Controlla elenco località	locations		array of string	Matrice di una o più posizioni del data center in cui eseguire questo controllo.
Controlla elenco tag	tags		array of string	Tag per organizzare e filtrare i controlli.
Tipo di escalation	escalationType		string	Determina il tipo di escalation da usare.
Soglia di esecuzione non riuscita	failedRunThreshold		number	Dopo il numero di controlli consecutivi non riusciti che devono essere inviati una notifica di avviso.
Soglia di errore minuti	minutesFailingThreshold		number	Dopo quanti minuti dopo l'avvio di un controllo ha esito negativo, deve essere inviato un avviso.
Importo	amount		number	Numero di promemoria da inviare dopo la notifica di avviso iniziale.
Intervallo	interval		number	A quale intervallo devono essere inviati i promemoria.
Enabled	enabled		boolean	Determina se le notifiche di avviso devono essere inviate per i certificati SSL in scadenza.
Soglia avviso	alertThreshold		integer	In quale momento iniziare a inviare avvisi sui certificati SSL.
Usare le impostazioni di avviso globali	useGlobalAlertSettings		boolean	Se true, verrà usata l'impostazione di avviso a livello di account, non l'impostazione dell'avviso definita in questa verifica.
ID del Gruppo	groupId		number	L'identificatore del gruppo di controllo di cui fa parte questo controllo.
Ordine di gruppo	groupOrder		number	Posizione di questo controllo in un gruppo di controllo. Determina in quali controlli degli ordini vengono eseguiti quando un gruppo viene attivato dall'API o da CI/CD.
Runtime ID	runtimeId		string	La versione di runtime, ovvero il set fisso di dipendenze di runtime, usato per eseguire questo controllo.
ID canale di avviso	alertChannelId	True	number	Identificatore del canale di avviso.
Attivato	activated	True	boolean	Se attivato.
Check Type	checkType		string	Tipo del controllo.
Frequenza	frequency		integer	Frequenza con cui il controllo deve essere eseguito in minuti.
Offset frequenza	frequencyOffset		integer	Usato per impostare i secondi per controllare le frequenze in meno di 1 minuti (solo per i controlli API) e distribuirne i controlli in un intervallo di tempo per le frequenze di oltre 1 minuto. Funziona come segue: i controlli con una frequenza pari a 0 possono avere un frequencyOffset pari a 10, 20 o 30, vale a dire che verranno eseguiti ogni 10, 20 o 30 secondi. I controlli con una frequenza inferiore a e uguale a 60 possono avere un frequencyOffset compreso tra 1 e un valore massimo in base alla formula Math.floor(frequency * 10), ad esempio per un controllo eseguito ogni 5 minuti il valore max frequencyOffset è 50. I controlli con una frequenza superiore a 60 possono avere un frequencyOffset compreso tra 1 e un valore massimo in base alla formula Math.ceil(frequency / 60), ad esempio per un controllo eseguito ogni 720 minuti, il valore max frequencyOffset è 12.
Controlla richiesta	request	True	object	Richiesta di controllo.
Sceneggiatura	script	True	string	Script.
Key	key	True	string	Chiave della variabile di ambiente (questo valore non può essere modificato).
Value	value	True	string	Valore della variabile di ambiente.
Bloccato	locked		boolean	Usato solo nell'interfaccia utente per nascondere il valore come una password.
ID frammento di codice di installazione	setupSnippetId		number	Riferimento di identificatore a un frammento di codice da usare nella fase di installazione di un controllo API.
ID frammento di codice di disinstallazione	tearDownSnippetId		number	Riferimento di identificatore a un frammento di codice da usare nella fase di disinstallazione di un controllo API.
Script di installazione locale	localSetupScript		string	Parte valida di Node.js codice da eseguire nella fase di installazione.
Script di disinstallazione locale	localTearDownScript		string	Parte valida di Node.js codice da eseguire nella fase di disinstallazione.
Tempo di risposta danneggiato	degradedResponseTime		number	Tempo di risposta in millisecondi in cui un controllo deve essere considerato danneggiato.
Tempo massimo di risposta	maxResponseTime		number	Tempo di risposta in millisecondi in cui un controllo deve essere considerato non riuscito.
Posizioni private	privateLocations		array of string	Matrice di una o più posizioni private in cui eseguire il controllo.

Restituisce

Corpo

Check

Aggiornare un controllo API

ID operazione:

PutV1ChecksApiId

Aggiorna un controllo API.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	string	Identificatore.
Assegnazione automatica avvisi	autoAssignAlerts		boolean	Determina se un nuovo controllo verrà aggiunto automaticamente come sottoscrittore a tutti i canali di avviso esistenti al momento della creazione.
Nome	name		string	Nome del controllo.
Attivato	activated		boolean	Determina se il controllo è in esecuzione o meno.
Disattivato	muted		boolean	Determina se le notifiche verranno inviate quando un controllo ha esito negativo e/o viene ripristinato.
Verifica doppia	doubleCheck		boolean	L'impostazione di questa proprietà su true attiverà un nuovo tentativo quando un controllo non riesce dall'area non riuscita e un'altra area selezionata in modo casuale prima di contrassegnare il controllo come non riuscito.
Dovrebbe avere esito negativo	shouldFail		boolean	Consente di invertire il comportamento di quando un controllo viene considerato non riuscita. Consente di convalidare lo stato di errore, ad esempio 404.
Controlla elenco località	locations		array of string	Matrice di una o più posizioni del data center in cui eseguire questo controllo.
Controlla elenco tag	tags		array of string	Tag per organizzare e filtrare i controlli.
Tipo di escalation	escalationType		string	Determina il tipo di escalation da usare.
Soglia di esecuzione non riuscita	failedRunThreshold		number	Dopo il numero di controlli consecutivi non riusciti che devono essere inviati una notifica di avviso.
Soglia di errore minuti	minutesFailingThreshold		number	Dopo quanti minuti dopo l'avvio di un controllo ha esito negativo, deve essere inviato un avviso.
Importo	amount		number	Numero di promemoria da inviare dopo la notifica di avviso iniziale.
Intervallo	interval		number	A quale intervallo devono essere inviati i promemoria.
Enabled	enabled		boolean	Determina se le notifiche di avviso devono essere inviate per i certificati SSL in scadenza.
Soglia avviso	alertThreshold		integer	In quale momento iniziare a inviare avvisi sui certificati SSL.
Usare le impostazioni di avviso globali	useGlobalAlertSettings		boolean	Se true, verrà usata l'impostazione di avviso a livello di account, non l'impostazione dell'avviso definita in questa verifica.
ID del Gruppo	groupId		number	L'identificatore del gruppo di controllo di cui fa parte questo controllo.
Ordine di gruppo	groupOrder		number	Posizione di questo controllo in un gruppo di controllo. Determina in quali controlli degli ordini vengono eseguiti quando un gruppo viene attivato dall'API o da CI/CD.
Runtime ID	runtimeId		string	La versione di runtime, ovvero il set fisso di dipendenze di runtime, usato per eseguire questo controllo.
ID canale di avviso	alertChannelId	True	number	Identificatore del canale di avviso.
Attivato	activated	True	boolean	Se attivato.
method	method	True	string
URL	url	True	string	Indirizzo URL.
Seguire i reindirizzamenti	followRedirects		boolean	Indica se seguire i reindirizzamenti.
Ignorare SSL	skipSSL		boolean	Se ignorare SSL.
Corpo	body		string	Il corpo.
Tipo di corpo	bodyType		string	Tipo di corpo.
Key	key	True	string	Tasto.
Value	value	True	string	Valore.
Bloccato	locked		boolean	Se bloccato.
Fonte	source		string	Origine.
Proprietà	property		string	Proprietà .
Comparison	comparison		string	Confronto.
Obiettivo	target		string	Destinazione.
Nome utente	username	True	string	Nome utente.
Parola chiave	password	True	string	Password.
Frequenza	frequency		integer	Frequenza con cui il controllo deve essere eseguito in minuti.
ID frammento di codice di disinstallazione	tearDownSnippetId		number	Riferimento di identificatore a un frammento di codice da usare nella fase di disinstallazione di un controllo API.
ID frammento di codice di installazione	setupSnippetId		number	Riferimento di identificatore a un frammento di codice da usare nella fase di installazione di un controllo API.
Offset frequenza	frequencyOffset		integer	Utilizzato per impostare i secondi per controllare le frequenze di meno di 1 minuto e distribuirne i controlli in un intervallo di tempo per le frequenze di oltre 1 minuto. Funziona come segue: i controlli con una frequenza pari a 0 possono avere un frequencyOffset pari a 10, 20 o 30, vale a dire che verranno eseguiti ogni 10, 20 o 30 secondi. I controlli con una frequenza inferiore a e uguale a 60 possono avere un frequencyOffset compreso tra 1 e un valore massimo in base alla formula Math.floor(frequency * 10), ad esempio per un controllo eseguito ogni 5 minuti il valore max frequencyOffset è 50. I controlli con una frequenza superiore a 60 possono avere un frequencyOffset compreso tra 1 e un valore massimo in base alla formula Math.ceil(frequency / 60), ad esempio per un controllo eseguito ogni 720 minuti, il valore max frequencyOffset è 12.
Script di installazione locale	localSetupScript		string	Parte valida di Node.js codice da eseguire nella fase di installazione.
Script di disinstallazione locale	localTearDownScript		string	Parte valida di Node.js codice da eseguire nella fase di disinstallazione.
Tempo di risposta danneggiato	degradedResponseTime		number	Tempo di risposta in millisecondi in cui un controllo deve essere considerato danneggiato.
Tempo massimo di risposta	maxResponseTime		number	Tempo di risposta in millisecondi in cui un controllo deve essere considerato non riuscito.
Posizioni private	privateLocations		array of string	Matrice di una o più posizioni private in cui eseguire il controllo.

Restituisce

Corpo

CheckAPI

Aggiornare un controllo del browser

ID operazione:

PutV1ChecksBrowserId

Aggiorna un controllo del browser.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	string	Identificatore.
Assegnazione automatica avvisi	autoAssignAlerts		boolean	Determina se un nuovo controllo verrà aggiunto automaticamente come sottoscrittore a tutti i canali di avviso esistenti al momento della creazione.
Nome	name		string	Nome del controllo.
Attivato	activated		boolean	Determina se il controllo è in esecuzione o meno.
Disattivato	muted		boolean	Determina se le notifiche verranno inviate quando un controllo ha esito negativo e/o viene ripristinato.
Verifica doppia	doubleCheck		boolean	L'impostazione di questa proprietà su true attiverà un nuovo tentativo quando un controllo non riesce dall'area non riuscita e un'altra area selezionata in modo casuale prima di contrassegnare il controllo come non riuscito.
Dovrebbe avere esito negativo	shouldFail		boolean	Consente di invertire il comportamento di quando un controllo viene considerato non riuscita. Consente di convalidare lo stato di errore, ad esempio 404.
Controlla elenco località	locations		array of string	Matrice di una o più posizioni del data center in cui eseguire questo controllo.
Controlla elenco tag	tags		array of string	Tag per organizzare e filtrare i controlli.
Tipo di escalation	escalationType		string	Determina il tipo di escalation da usare.
Soglia di esecuzione non riuscita	failedRunThreshold		number	Dopo il numero di controlli consecutivi non riusciti che devono essere inviati una notifica di avviso.
Soglia di errore minuti	minutesFailingThreshold		number	Dopo quanti minuti dopo l'avvio di un controllo ha esito negativo, deve essere inviato un avviso.
Importo	amount		number	Numero di promemoria da inviare dopo la notifica di avviso iniziale.
Intervallo	interval		number	A quale intervallo devono essere inviati i promemoria.
Enabled	enabled		boolean	Determina se le notifiche di avviso devono essere inviate per i certificati SSL in scadenza.
Soglia avviso	alertThreshold		integer	In quale momento iniziare a inviare avvisi sui certificati SSL.
Usare le impostazioni di avviso globali	useGlobalAlertSettings		boolean	Se true, verrà usata l'impostazione di avviso a livello di account, non l'impostazione dell'avviso definita in questa verifica.
ID del Gruppo	groupId		number	L'identificatore del gruppo di controllo di cui fa parte questo controllo.
Ordine di gruppo	groupOrder		number	Posizione di questo controllo in un gruppo di controllo. Determina in quali controlli degli ordini vengono eseguiti quando un gruppo viene attivato dall'API o da CI/CD.
Runtime ID	runtimeId		string	La versione di runtime, ovvero il set fisso di dipendenze di runtime, usato per eseguire questo controllo.
ID canale di avviso	alertChannelId	True	number	Identificatore del canale di avviso.
Attivato	activated	True	boolean	Se attivato.
Key	key	True	string	Chiave della variabile di ambiente (questo valore non può essere modificato).
Value	value	True	string	Valore della variabile di ambiente.
Bloccato	locked		boolean	Usato solo nell'interfaccia utente per nascondere il valore come una password.
Frequenza	frequency		integer	Frequenza con cui il controllo deve essere eseguito in minuti.
Sceneggiatura	script		string	Una parte valida di Node.js codice Javascript che descrive un'interazione del browser con i framework Puppeteer o Playwright.
Posizioni private	privateLocations		array of string	Matrice di una o più posizioni private in cui eseguire il controllo.

Restituisce

Corpo

CheckBrowser

Aggiornare un dashboard

ID operazione:

PutV1DashboardsDashboardid

Aggiorna un dashboard. Restituisce un valore 409 quando si tenta di creare un dashboard con un URL personalizzato o un dominio personalizzato già acquisito.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	dashboardId	True	string	Identificatore del dashboard.
URL personalizzato	customUrl		string	Nome di sottodominio in checklyhq.com. Deve essere univoco per tutti gli utenti.
Dominio personalizzato	customDomain		string	Un dominio utente personalizzato, ad esempio status.example.com. Vedere la documentazione sull'aggiornamento dell'utilizzo di DNS e SSL.
Logo	logo		string	URL che punta a un file di immagine.
Favicon	favicon		string	URL che punta a un file di immagine usato come favicon del dashboard.
Link	link		string	Collegamento URL da reindirizzare quando si fa clic sul logo del dashboard.
Header	header		string	Parte di testo visualizzata nella parte superiore del dashboard.
Description	description		string	Una parte di testo visualizzata sotto l'intestazione o il titolo del dashboard.
Larghezza	width		string	Determina se usare lo schermo intero o lo stato attivo al centro.
Frequenza	refreshRate		number	Frequenza con cui aggiornare il dashboard in pochi secondi.
Impaginare	paginate		boolean	Determina che la paginazione è attivata o disattivata.
Frequenza di impaginazione	paginationRate		number	Frequenza con cui attivare la paginazione in secondi.
Controlli per pagina	checksPerPage		number	Numero di controlli visualizzati per pagina.
Operatore Use And	useTagsAndOperator		boolean	Quando usare l'operatore AND per la ricerca di tag.
Nascondi tag	hideTags		boolean	Mostrare o nascondere i tag nel dashboard.
Elenco tag dashboard	tags		array of string	Elenco di uno o più tag che filtrano i controlli da visualizzare nel dashboard.

Restituisce

Corpo

Dashboard

Aggiornare un frammento di codice

ID operazione:

PutV1SnippetsId

Aggiorna un frammento di codice.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	integer	Identificatore.
Nome	name	True	string	Nome del frammento di codice.
Sceneggiatura	script	True	string	Il codice Node.js che interagisce con il ciclo di vita del controllo API o funziona come parziale per i controlli del browser.

Restituisce

Corpo

Snippet

Aggiornare un gruppo di controllo

ID operazione:

PutV1CheckgroupsId

Aggiorna un gruppo di controllo.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	integer	Identificatore.
Assegnazione automatica avvisi	autoAssignAlerts		boolean	Determina se un nuovo controllo verrà aggiunto automaticamente come sottoscrittore a tutti i canali di avviso esistenti al momento della creazione.
Nome	name		string	Nome del gruppo di controllo.
Attivato	activated		boolean	Determina se i controlli nel gruppo sono in esecuzione o meno.
Disattivato	muted		boolean	Determina se le notifiche verranno inviate quando un'archiviazione in questo gruppo ha esito negativo e/o viene ripristinata.
Controlla elenco tag di gruppo	tags		array of string	Tag per organizzare e filtrare i controlli.
Controlla elenco località gruppo	locations		array of string	Matrice di una o più posizioni del data center in cui eseguire i controlli.
Concurrency	concurrency		number	Determina il numero di controlli richiamati simultaneamente durante l'attivazione di un gruppo di controllo da CI/CD o tramite l'API.
URL	url		string	URL di base per questo gruppo a cui è possibile fare riferimento con la variabile {{GROUP_BASE_URL}} in tutti i controlli di gruppo.
Key	key	True	string	Tasto.
Value	value	True	string	Valore.
Bloccato	locked		boolean	Se bloccato.
Fonte	source		string	Origine.
Proprietà	property		string	Proprietà .
Comparison	comparison		string	Confronto.
Obiettivo	target		string	Destinazione.
Nome utente	username	True	string	Nome utente.
Parola chiave	password	True	string	Password.
Controllare le impostazioni predefinite di Controllo browser per la creazione di gruppi	browserCheckDefaults		object	Il controllo dei valori predefiniti del browser per la creazione del gruppo di controllo.
Runtime ID	runtimeId		string	La versione di runtime, ovvero il set fisso di dipendenze di runtime, usato per eseguire i controlli in questo gruppo.
Key	key	True	string	Chiave della variabile di ambiente (questo valore non può essere modificato).
Value	value	True	string	Valore della variabile di ambiente.
Bloccato	locked		boolean	Usato solo nell'interfaccia utente per nascondere il valore come una password.
Verifica doppia	doubleCheck		boolean	L'impostazione di questa proprietà su true attiverà un nuovo tentativo quando un controllo non riesce dall'area non riuscita e un'altra area selezionata in modo casuale prima di contrassegnare il controllo come non riuscito.
Usare le impostazioni di avviso globali	useGlobalAlertSettings		boolean	Se true, verrà usata l'impostazione di avviso a livello di account, non l'impostazione di avviso definita in questo gruppo di controllo.
Tipo di escalation	escalationType		string	Determina il tipo di escalation da usare.
Soglia di esecuzione non riuscita	failedRunThreshold		number	Dopo il numero di controlli consecutivi non riusciti che devono essere inviati una notifica di avviso.
Soglia di errore minuti	minutesFailingThreshold		number	Dopo quanti minuti dopo l'avvio di un controllo ha esito negativo, deve essere inviato un avviso.
Importo	amount		number	Numero di promemoria da inviare dopo la notifica di avviso iniziale.
Intervallo	interval		number	A quale intervallo devono essere inviati i promemoria.
Enabled	enabled		boolean	Determina se le notifiche di avviso devono essere inviate per i certificati SSL in scadenza.
Soglia avviso	alertThreshold		integer	In quale momento iniziare a inviare avvisi sui certificati SSL.
ID canale di avviso	alertChannelId	True	number	Identificatore del canale di avviso.
Attivato	activated	True	boolean	Se attivato.
ID frammento di codice di installazione	setupSnippetId		number	Riferimento di identificatore a un frammento di codice da usare nella fase di installazione di un controllo API in questo gruppo.
ID frammento di codice di disinstallazione	tearDownSnippetId		number	Riferimento di identificatore a un frammento di codice da usare nella fase di disinstallazione di un controllo API in questo gruppo.
Script di installazione locale	localSetupScript		string	Parte valida di Node.js codice da eseguire nella fase di installazione di un controllo API in questo gruppo.
Script di disinstallazione locale	localTearDownScript		string	Parte valida di Node.js codice da eseguire nella fase di disinstallazione di un controllo API in questo gruppo.
Controllare le posizioni private	privateLocations		array of string	Matrice di una o più posizioni private in cui eseguire i controlli.

Restituisce

Corpo

CheckGroup

Aggiornare una finestra di manutenzione

ID operazione:

PutV1MaintenancewindowsId

Aggiorna una finestra di manutenzione.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	integer	Identificatore.
Nome	name	True	string	Nome della finestra di manutenzione.
Elenco tag finestra di manutenzione	tags		array of string	I nomi della finestra di manutenzione controlli e gruppi devono essere applicati.
Inizia da	startsAt	True	date	Data di inizio della finestra di manutenzione.
Termina in corrispondenza di	endsAt	True	date	Data di fine della finestra di manutenzione.
Intervallo ripetizione	repeatInterval		number	Intervallo di ripetizione della finestra di manutenzione dalla prima occorrenza.
Unità ripetizione	repeatUnit	True	string	Strategia di ripetizione per la finestra di manutenzione.
Ripeti termina in corrispondenza di	repeatEndsAt		date	Data di fine in cui la finestra di manutenzione deve interrompere la ripetizione.

Restituisce

Corpo

MaintenanceWindow

Aggiornare una posizione privata

ID operazione:

PutV1PrivatelocationsId

Aggiorna una posizione privata.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	string	Identificatore.
Nome	name	True	string	Nome assegnato alla posizione privata.
Icona	icon		string	Icona.

Restituisce

Corpo

commonPrivateLocationSchemaResponse

Aggiornare una variabile di ambiente

ID operazione:

PutV1VariablesKey

Aggiorna una variabile di ambiente. Usa il campo chiave come identificatore per l'aggiornamento. Aggiorna solo il valore e la proprietà bloccata.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Key	key	True	string	Tasto.
Key	key		string	Chiave della variabile di ambiente (questo valore non può essere modificato).
Value	value	True	string	Valore della variabile di ambiente.
Bloccato	locked		boolean	Usato solo nell'interfaccia utente per nascondere il valore come una password.

Restituisce

Corpo

EnvironmentVariable

Creare il trigger check

ID operazione:

PostV1TriggersChecksCheckid

Crea il trigger check.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Controllare l'ID	checkId	True	string	Identificatore di controllo.

Restituisce

Corpo

CheckTrigger

Creare il trigger del gruppo di controllo

ID operazione:

PostV1TriggersCheckgroupsGroupid

Crea il trigger del gruppo di controllo.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Gruppo	groupId	True	integer	Identificatore del gruppo.

Restituisce

Corpo

CheckGroupTrigger

Creare un canale di avviso

ID operazione:

PostV1Alertchannels

Crea un nuovo canale di avviso.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id		number	Identificatore.
Controllare l'ID	checkId		guid	Identificatore di controllo.
ID del Gruppo	groupId		number	Identificatore del gruppo.
Attivato	activated	True	boolean	Se attivato.
TIPO	type	True	string	Tipo.
Creazione di una configurazione del canale di avviso	config	True	object	Configurazione di creazione del canale di avviso.
Invia ripristino	sendRecovery		boolean	Indica se inviare il ripristino.
Errore di invio	sendFailure		boolean	Indica se l'errore di invio.
Invio danneggiato	sendDegraded		boolean	Indica se l'invio è danneggiato.
Scadenza SSL	sslExpiry		boolean	Determina se un avviso deve essere inviato per i certificati SSL in scadenza.
Soglia di scadenza SSL	sslExpiryThreshold		integer	In quale momento iniziare a inviare avvisi sui certificati SSL.

Restituisce

Corpo

AlertChannel

Creare un controllo [DEPRECATO]

ID operazione:

PostV1Checks

[DEPRECATO] Questo endpoint verrà rimosso il 4 luglio 2022. Usare invece POST /checks/api o POST /checks/browser. Crea una nuova API o un controllo del browser. Restituisce un valore 402 quando si supera il limite del piano. Quando si usa globalAlertSettings, può alertSettings essere null

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Assegnazione automatica avvisi	autoAssignAlerts		boolean	Determina se un nuovo controllo verrà aggiunto automaticamente come sottoscrittore a tutti i canali di avviso esistenti al momento della creazione.
Nome	name	True	string	Nome del controllo.
Attivato	activated	True	boolean	Determina se il controllo è in esecuzione o meno.
Disattivato	muted		boolean	Determina se le notifiche verranno inviate quando un controllo ha esito negativo e/o viene ripristinato.
Verifica doppia	doubleCheck		boolean	L'impostazione di questa proprietà su true attiverà un nuovo tentativo quando un controllo non riesce dall'area non riuscita e un'altra area selezionata in modo casuale prima di contrassegnare il controllo come non riuscito.
Dovrebbe avere esito negativo	shouldFail		boolean	Consente di invertire il comportamento di quando un controllo viene considerato non riuscita. Consente di convalidare lo stato di errore, ad esempio 404.
Controlla elenco località	locations		array of string	Matrice di una o più posizioni del data center in cui eseguire questo controllo.
Controlla elenco tag	tags		array of string	Tag per organizzare e filtrare i controlli.
Tipo di escalation	escalationType		string	Determina il tipo di escalation da usare.
Soglia di esecuzione non riuscita	failedRunThreshold		number	Dopo il numero di controlli consecutivi non riusciti che devono essere inviati una notifica di avviso.
Soglia di errore minuti	minutesFailingThreshold		number	Dopo quanti minuti dopo l'avvio di un controllo ha esito negativo, deve essere inviato un avviso.
Importo	amount		number	Numero di promemoria da inviare dopo la notifica di avviso iniziale.
Intervallo	interval		number	A quale intervallo devono essere inviati i promemoria.
Enabled	enabled		boolean	Determina se le notifiche di avviso devono essere inviate per i certificati SSL in scadenza.
Soglia avviso	alertThreshold		integer	In quale momento iniziare a inviare avvisi sui certificati SSL.
Usare le impostazioni di avviso globali	useGlobalAlertSettings		boolean	Se true, verrà usata l'impostazione di avviso a livello di account, non l'impostazione dell'avviso definita in questa verifica.
ID del Gruppo	groupId		number	L'identificatore del gruppo di controllo di cui fa parte questo controllo.
Ordine di gruppo	groupOrder		number	Posizione di questo controllo in un gruppo di controllo. Determina in quali controlli degli ordini vengono eseguiti quando un gruppo viene attivato dall'API o da CI/CD.
Runtime ID	runtimeId		string	La versione di runtime, ovvero il set fisso di dipendenze di runtime, usato per eseguire questo controllo.
ID canale di avviso	alertChannelId	True	number	Identificatore del canale di avviso.
Attivato	activated	True	boolean	Se attivato.
Check Type	checkType	True	string	Tipo del controllo.
Frequenza	frequency		integer	Frequenza con cui il controllo deve essere eseguito in minuti.
Offset frequenza	frequencyOffset		integer	Usato per impostare i secondi per controllare le frequenze in meno di 1 minuti (solo per i controlli API) e distribuirne i controlli in un intervallo di tempo per le frequenze di oltre 1 minuto. Funziona come segue: i controlli con una frequenza pari a 0 possono avere un frequencyOffset pari a 10, 20 o 30, vale a dire che verranno eseguiti ogni 10, 20 o 30 secondi. I controlli con una frequenza inferiore a e uguale a 60 possono avere un frequencyOffset compreso tra 1 e un valore massimo in base alla formula Math.floor(frequency * 10), ad esempio per un controllo eseguito ogni 5 minuti il valore max frequencyOffset è 50. I controlli con una frequenza superiore a 60 possono avere un frequencyOffset compreso tra 1 e un valore massimo in base alla formula Math.ceil(frequency / 60), ad esempio per un controllo eseguito ogni 720 minuti, il valore max frequencyOffset è 12.
Controlla richiesta	request		object	Richiesta di controllo.
Sceneggiatura	script	True	string	Script.
Key	key	True	string	Chiave della variabile di ambiente (questo valore non può essere modificato).
Value	value	True	string	Valore della variabile di ambiente.
Bloccato	locked		boolean	Usato solo nell'interfaccia utente per nascondere il valore come una password.
ID frammento di codice di installazione	setupSnippetId		number	Riferimento di identificatore a un frammento di codice da usare nella fase di installazione di un controllo API.
ID frammento di codice di disinstallazione	tearDownSnippetId		number	Riferimento di identificatore a un frammento di codice da usare nella fase di disinstallazione di un controllo API.
Script di installazione locale	localSetupScript		string	Parte valida di Node.js codice da eseguire nella fase di installazione.
Script di disinstallazione locale	localTearDownScript		string	Parte valida di Node.js codice da eseguire nella fase di disinstallazione.
Tempo di risposta danneggiato	degradedResponseTime		number	Tempo di risposta in millisecondi in cui un controllo deve essere considerato danneggiato.
Tempo massimo di risposta	maxResponseTime		number	Tempo di risposta in millisecondi in cui un controllo deve essere considerato non riuscito.
Posizioni private	privateLocations		array of string	Matrice di una o più posizioni private in cui eseguire il controllo.

Restituisce

Corpo

Check

Creare un controllo API

ID operazione:

PostV1ChecksApi

Crea un nuovo controllo API. Restituisce un valore 402 quando si supera il limite del piano. Quando si usa globalAlertSetting, può alertSetting essere null

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Assegnazione automatica avvisi	autoAssignAlerts		boolean	Determina se un nuovo controllo verrà aggiunto automaticamente come sottoscrittore a tutti i canali di avviso esistenti al momento della creazione.
Nome	name	True	string	Nome del controllo.
Attivato	activated	True	boolean	Determina se il controllo è in esecuzione o meno.
Disattivato	muted		boolean	Determina se le notifiche verranno inviate quando un controllo ha esito negativo e/o viene ripristinato.
Verifica doppia	doubleCheck		boolean	L'impostazione di questa proprietà su true attiverà un nuovo tentativo quando un controllo non riesce dall'area non riuscita e un'altra area selezionata in modo casuale prima di contrassegnare il controllo come non riuscito.
Dovrebbe avere esito negativo	shouldFail		boolean	Consente di invertire il comportamento di quando un controllo viene considerato non riuscita. Consente di convalidare lo stato di errore, ad esempio 404.
Controlla elenco località	locations		array of string	Matrice di una o più posizioni del data center in cui eseguire questo controllo.
Controlla elenco tag	tags		array of string	Tag per organizzare e filtrare i controlli.
Tipo di escalation	escalationType		string	Determina il tipo di escalation da usare.
Soglia di esecuzione non riuscita	failedRunThreshold		number	Dopo il numero di controlli consecutivi non riusciti che devono essere inviati una notifica di avviso.
Soglia di errore minuti	minutesFailingThreshold		number	Dopo quanti minuti dopo l'avvio di un controllo ha esito negativo, deve essere inviato un avviso.
Importo	amount		number	Numero di promemoria da inviare dopo la notifica di avviso iniziale.
Intervallo	interval		number	A quale intervallo devono essere inviati i promemoria.
Enabled	enabled		boolean	Determina se le notifiche di avviso devono essere inviate per i certificati SSL in scadenza.
Soglia avviso	alertThreshold		integer	In quale momento iniziare a inviare avvisi sui certificati SSL.
Usare le impostazioni di avviso globali	useGlobalAlertSettings		boolean	Se true, verrà usata l'impostazione di avviso a livello di account, non l'impostazione dell'avviso definita in questa verifica.
ID del Gruppo	groupId		number	L'identificatore del gruppo di controllo di cui fa parte questo controllo.
Ordine di gruppo	groupOrder		number	Posizione di questo controllo in un gruppo di controllo. Determina in quali controlli degli ordini vengono eseguiti quando un gruppo viene attivato dall'API o da CI/CD.
Runtime ID	runtimeId		string	La versione di runtime, ovvero il set fisso di dipendenze di runtime, usato per eseguire questo controllo.
ID canale di avviso	alertChannelId	True	number	Identificatore del canale di avviso.
Attivato	activated	True	boolean	Se attivato.
method	method	True	string
URL	url	True	string	Indirizzo URL.
Seguire i reindirizzamenti	followRedirects		boolean	Indica se segue i reindirizzamenti.
Ignorare SSL	skipSSL		boolean	Se ignorare SSL.
Corpo	body		string	Il corpo.
bodyType	bodyType		string
Key	key	True	string	Tasto.
Value	value	True	string	Valore.
Bloccato	locked		boolean	Se bloccato.
Fonte	source		string	Origine.
Proprietà	property		string	Proprietà .
Comparison	comparison		string	Confronto.
Obiettivo	target		string	Destinazione.
Nome utente	username	True	string	Nome utente.
Parola chiave	password	True	string	Password.
Frequenza	frequency		integer	Frequenza con cui il controllo deve essere eseguito in minuti.
ID frammento di codice di disinstallazione	tearDownSnippetId		number	Riferimento di identificatore a un frammento di codice da usare nella fase di disinstallazione di un controllo API.
ID frammento di codice di installazione	setupSnippetId		number	Riferimento di identificatore a un frammento di codice da usare nella fase di installazione di un controllo API.
Offset frequenza	frequencyOffset		integer	Utilizzato per impostare i secondi per controllare le frequenze di meno di 1 minuto e distribuirne i controlli in un intervallo di tempo per le frequenze di oltre 1 minuto. Funziona come segue: i controlli con una frequenza pari a 0 possono avere un frequencyOffset pari a 10, 20 o 30, vale a dire che verranno eseguiti ogni 10, 20 o 30 secondi. I controlli con una frequenza inferiore a e uguale a 60 possono avere un frequencyOffset compreso tra 1 e un valore massimo in base alla formula Math.floor(frequency * 10), ad esempio per un controllo eseguito ogni 5 minuti il valore max frequencyOffset è 50. I controlli con una frequenza superiore a 60 possono avere un frequencyOffset compreso tra 1 e un valore massimo in base alla formula Math.ceil(frequency / 60), ad esempio per un controllo eseguito ogni 720 minuti, il valore max frequencyOffset è 12.
Script di installazione locale	localSetupScript		string	Parte valida di Node.js codice da eseguire nella fase di installazione.
Script di disinstallazione locale	localTearDownScript		string	Parte valida di Node.js codice da eseguire nella fase di disinstallazione.
Tempo di risposta danneggiato	degradedResponseTime		number	Tempo di risposta in millisecondi in cui un controllo deve essere considerato danneggiato.
Tempo massimo di risposta	maxResponseTime		number	Tempo di risposta in millisecondi in cui un controllo deve essere considerato non riuscito.
Posizioni private	privateLocations		array of string	Matrice di una o più posizioni private in cui eseguire il controllo.

Restituisce

Corpo

CheckAPI

Creare un controllo del browser

ID operazione:

PostV1ChecksBrowser

Crea un nuovo controllo del browser. Restituisce un valore 402 quando si supera il limite del piano. Quando si usa globalAlertSetting, può alertSetting essere null

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Assegnazione automatica avvisi	autoAssignAlerts		boolean	Determina se un nuovo controllo verrà aggiunto automaticamente come sottoscrittore a tutti i canali di avviso esistenti al momento della creazione.
Nome	name	True	string	Nome del controllo.
Attivato	activated	True	boolean	Determina se il controllo è in esecuzione o meno.
Disattivato	muted		boolean	Determina se le notifiche verranno inviate quando un controllo ha esito negativo e/o viene ripristinato.
Verifica doppia	doubleCheck		boolean	L'impostazione di questa proprietà su true attiverà un nuovo tentativo quando un controllo non riesce dall'area non riuscita e un'altra area selezionata in modo casuale prima di contrassegnare il controllo come non riuscito.
Dovrebbe avere esito negativo	shouldFail		boolean	Consente di invertire il comportamento di quando un controllo viene considerato non riuscita. Consente di convalidare lo stato di errore, ad esempio 404.
Controlla elenco località	locations		array of string	Matrice di una o più posizioni del data center in cui eseguire questo controllo.
Controlla elenco tag	tags		array of string	Tag per organizzare e filtrare i controlli.
Tipo di escalation	escalationType		string	Determina il tipo di escalation da usare.
Soglia di esecuzione non riuscita	failedRunThreshold		number	Dopo il numero di controlli consecutivi non riusciti che devono essere inviati una notifica di avviso.
Soglia di errore minuti	minutesFailingThreshold		number	Dopo quanti minuti dopo l'avvio di un controllo ha esito negativo, deve essere inviato un avviso.
Importo	amount		number	Numero di promemoria da inviare dopo la notifica di avviso iniziale.
Intervallo	interval		number	A quale intervallo devono essere inviati i promemoria.
Enabled	enabled		boolean	Determina se le notifiche di avviso devono essere inviate per i certificati SSL in scadenza.
Soglia avviso	alertThreshold		integer	In quale momento iniziare a inviare avvisi sui certificati SSL.
Usare le impostazioni di avviso globali	useGlobalAlertSettings		boolean	Se true, verrà usata l'impostazione di avviso a livello di account, non l'impostazione dell'avviso definita in questa verifica.
ID del Gruppo	groupId		number	L'identificatore del gruppo di controllo di cui fa parte questo controllo.
Ordine di gruppo	groupOrder		number	Posizione di questo controllo in un gruppo di controllo. Determina in quali controlli degli ordini vengono eseguiti quando un gruppo viene attivato dall'API o da CI/CD.
Runtime ID	runtimeId		string	La versione di runtime, ovvero il set fisso di dipendenze di runtime, usato per eseguire questo controllo.
ID canale di avviso	alertChannelId	True	number	Identificatore del canale di avviso.
Attivato	activated	True	boolean	Se attivato.
Key	key	True	string	Chiave della variabile di ambiente (questo valore non può essere modificato).
Value	value	True	string	Valore della variabile di ambiente.
Bloccato	locked		boolean	Usato solo nell'interfaccia utente per nascondere il valore come una password.
Frequenza	frequency		integer	Frequenza con cui il controllo deve essere eseguito in minuti.
Sceneggiatura	script	True	string	Una parte valida di Node.js codice Javascript che descrive un'interazione del browser con i framework Puppeteer o Playwright.
Posizioni private	privateLocations		array of string	Matrice di una o più posizioni private in cui eseguire il controllo.

Restituisce

Corpo

CheckBrowser

Creare un dashboard

ID operazione:

PostV1Dashboards

Crea un nuovo dashboard. Restituisce un valore 409 quando si tenta di creare un dashboard con un URL personalizzato o un dominio personalizzato già acquisito.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
URL personalizzato	customUrl		string	Nome di sottodominio in checklyhq.com. Deve essere univoco per tutti gli utenti.
Dominio personalizzato	customDomain		string	Un dominio utente personalizzato, ad esempio status.example.com. Vedere la documentazione sull'aggiornamento dell'utilizzo di DNS e SSL.
Logo	logo		string	URL che punta a un file di immagine.
Favicon	favicon		string	URL che punta a un file di immagine usato come favicon del dashboard.
Link	link		string	Collegamento URL da reindirizzare quando si fa clic sul logo del dashboard.
Header	header		string	Parte di testo visualizzata nella parte superiore del dashboard.
Description	description		string	Una parte di testo visualizzata sotto l'intestazione o il titolo del dashboard.
Larghezza	width		string	Determina se usare lo schermo intero o lo stato attivo al centro.
Frequenza	refreshRate		number	Frequenza con cui aggiornare il dashboard in pochi secondi.
Impaginare	paginate		boolean	Determina che la paginazione è attivata o disattivata.
Frequenza di impaginazione	paginationRate		number	Frequenza con cui attivare la paginazione in secondi.
Controlli per pagina	checksPerPage		number	Numero di controlli visualizzati per pagina.
Operatore Use And	useTagsAndOperator		boolean	Quando usare l'operatore AND per la ricerca di tag.
Nascondi tag	hideTags		boolean	Mostrare o nascondere i tag nel dashboard.
Elenco tag dashboard	tags		array of string	Elenco di uno o più tag che filtrano i controlli da visualizzare nel dashboard.

Restituisce

Corpo

Dashboard

Creare un frammento di codice

ID operazione:

PostV1Snippets

Crea un nuovo frammento di codice.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome	name	True	string	Nome del frammento di codice.
Sceneggiatura	script	True	string	Il codice Node.js che interagisce con il ciclo di vita del controllo API o funziona come parziale per i controlli del browser.

Restituisce

Corpo

Snippet

Creare un gruppo di controllo

ID operazione:

PostV1Checkgroups

Crea un nuovo gruppo di controlli. È possibile aggiungere controlli al gruppo impostando la proprietà groupId dei singoli controlli.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Assegnazione automatica avvisi	autoAssignAlerts		boolean	Determina se un nuovo controllo verrà aggiunto automaticamente come sottoscrittore a tutti i canali di avviso esistenti al momento della creazione.
Nome	name	True	string	Nome del gruppo di controllo.
Attivato	activated		boolean	Determina se i controlli nel gruppo sono in esecuzione o meno.
Disattivato	muted		boolean	Determina se le notifiche verranno inviate quando un'archiviazione in questo gruppo ha esito negativo e/o viene ripristinata.
Controlla elenco tag di gruppo	tags		array of string	Tag per organizzare e filtrare i controlli.
Controlla elenco località gruppo	locations		array of string	Matrice di una o più posizioni del data center in cui eseguire i controlli.
Concurrency	concurrency		number	Determina il numero di controlli richiamati simultaneamente durante l'attivazione di un gruppo di controllo da CI/CD o tramite l'API.
URL	url		string	URL di base per questo gruppo a cui è possibile fare riferimento con la variabile {{GROUP_BASE_URL}} in tutti i controlli di gruppo.
Key	key	True	string	Tasto.
Value	value	True	string	Valore.
Bloccato	locked		boolean	Se bloccato.
Fonte	source		string	Origine.
Proprietà	property		string	Proprietà .
Comparison	comparison		string	Confronto.
Obiettivo	target		string	Destinazione.
Nome utente	username	True	string	Nome utente.
Parola chiave	password	True	string	Password.
Controllare le impostazioni predefinite di Controllo browser per la creazione di gruppi	browserCheckDefaults		object	Il controllo dei valori predefiniti del browser per la creazione del gruppo di controllo.
Runtime ID	runtimeId		string	La versione di runtime, ovvero il set fisso di dipendenze di runtime, usato per eseguire i controlli in questo gruppo.
Key	key	True	string	Chiave della variabile di ambiente (questo valore non può essere modificato).
Value	value	True	string	Valore della variabile di ambiente.
Bloccato	locked		boolean	Usato solo nell'interfaccia utente per nascondere il valore come una password.
Verifica doppia	doubleCheck		boolean	L'impostazione di questa proprietà su true attiverà un nuovo tentativo quando un controllo non riesce dall'area non riuscita e un'altra area selezionata in modo casuale prima di contrassegnare il controllo come non riuscito.
Usare le impostazioni di avviso globali	useGlobalAlertSettings		boolean	Se true, verrà usata l'impostazione di avviso a livello di account, non l'impostazione di avviso definita in questo gruppo di controllo.
Tipo di escalation	escalationType		string	Determina il tipo di escalation da usare.
Soglia di esecuzione non riuscita	failedRunThreshold		number	Dopo il numero di controlli consecutivi non riusciti che devono essere inviati una notifica di avviso.
Soglia di errore minuti	minutesFailingThreshold		number	Dopo quanti minuti dopo l'avvio di un controllo ha esito negativo, deve essere inviato un avviso.
Importo	amount		number	Numero di promemoria da inviare dopo la notifica di avviso iniziale.
Intervallo	interval		number	A quale intervallo devono essere inviati i promemoria.
Enabled	enabled		boolean	Determina se le notifiche di avviso devono essere inviate per i certificati SSL in scadenza.
Soglia avviso	alertThreshold		integer	In quale momento iniziare a inviare avvisi sui certificati SSL.
ID canale di avviso	alertChannelId	True	number	Identificatore del canale di avviso.
Attivato	activated	True	boolean	Se attivato.
ID frammento di codice di installazione	setupSnippetId		number	Riferimento di identificatore a un frammento di codice da usare nella fase di installazione di un controllo API in questo gruppo.
ID frammento di codice di disinstallazione	tearDownSnippetId		number	Riferimento di identificatore a un frammento di codice da usare nella fase di disinstallazione di un controllo API in questo gruppo.
Script di installazione locale	localSetupScript		string	Parte valida di Node.js codice da eseguire nella fase di installazione di un controllo API in questo gruppo.
Script di disinstallazione locale	localTearDownScript		string	Parte valida di Node.js codice da eseguire nella fase di disinstallazione di un controllo API in questo gruppo.
Controllare le posizioni private	privateLocations		array of string	Matrice di una o più posizioni private in cui eseguire i controlli.

Restituisce

Corpo

CheckGroup

Creare una finestra di manutenzione

ID operazione:

PostV1Maintenancewindows

Crea una nuova finestra di manutenzione.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome	name	True	string	Nome della finestra di manutenzione.
Elenco tag finestra di manutenzione	tags		array of string	I nomi della finestra di manutenzione controlli e gruppi devono essere applicati.
Inizia da	startsAt	True	date	Data di inizio della finestra di manutenzione.
Termina in corrispondenza di	endsAt	True	date	Data di fine della finestra di manutenzione.
Intervallo ripetizione	repeatInterval		number	Intervallo di ripetizione della finestra di manutenzione dalla prima occorrenza.
Unità ripetizione	repeatUnit	True	string	Strategia di ripetizione per la finestra di manutenzione.
Ripeti termina in corrispondenza di	repeatEndsAt		date	Data di fine in cui la finestra di manutenzione deve interrompere la ripetizione.

Restituisce

Corpo

MaintenanceWindow

Creare una posizione privata

ID operazione:

PostV1Privatelocations

Crea una nuova posizione privata.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome	name	True	string	Nome assegnato alla posizione privata.
Nome slug	slugName	True	string	Nome di slug valido.
Icona	icon		string	Icona.

Restituisce

Corpo

commonPrivateLocationSchemaResponse

Creare una variabile di ambiente

ID operazione:

PostV1Variables

Crea una nuova variabile di ambiente.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Key	key	True	string	Chiave della variabile di ambiente (questo valore non può essere modificato).
Value	value	True	string	Valore della variabile di ambiente.
Bloccato	locked		boolean	Usato solo nell'interfaccia utente per nascondere il valore come una password.

Restituisce

Corpo

EnvironmentVariable

Elenca tutte le posizioni supportate

ID operazione:

GetV1Locations

Elenca tutte le posizioni supportate.

Restituisce

Elementi

LocationList

Elenca tutti i risultati dei controlli

ID operazione:

GetV1CheckresultsCheckid

Elenca i risultati completi del controllo non elaborato per un controllo specifico. I risultati non elaborati vengono mantenuto per 30 giorni. Dopo 30 giorni vengono cancellati. Tuttavia, si mantengono i risultati di rollup per un periodo indefinito. È possibile filtrare in base al tipo di controllo e al tipo di risultato per restringere l'elenco. Usare i to parametri e from per specificare un intervallo di date (timestamp UNIX in secondi). A seconda del tipo di controllo, alcuni campi potrebbero essere Null. Questo endpoint restituirà i dati entro un intervallo di sei ore. Se vengono impostati parametri da e a , devono essere al massimo sei ore di distanza. Se nessuno è impostato, si considererà il parametro per essere ora e dal parametro a sei ore prima. Se viene impostata solo la proprietà da a param, verrà impostata da a essere sei ore prima. Al contrario, se viene impostato solo il parametro da param, si considererà il parametro per essere sei ore dopo. La limitazione della frequenza viene applicata a questo endpoint, è possibile inviare al massimo 5 richieste/10 secondi.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Controllare l'ID	checkId	True	string	Identificatore di controllo.
Limite	limit		integer	Limitare il numero di risultati.
Number	page		number	Numero di pagina.
Da	from		date	Selezionare i documenti da questo timestamp UNIX (>= data). Il valore predefinito è ora - 6 ore.
Per	to		date	Selezionare gli avvisi fino a questo timestamp UNIX (< data). Il valore predefinito è 6 ore dopo.
Posizione	location		string	Fornire una posizione del data center, ad esempio eu-west-1 per filtrare in base alla posizione
Check Type	checkType		string	Tipo del controllo.
Errori	hasFailures		boolean	Il risultato del controllo presenta uno o più errori.

Restituisce

Elementi

CheckResultList

Elenca tutti i runtime supportati

ID operazione:

GetV1Runtimes

Elenca tutti i runtime supportati e i pacchetti NPM inclusi per i controlli del browser e gli script di installazione e disinstallazione per i controlli API.

Restituisce

Elementi

RuntimeList

Elencare gli avvisi per un controllo specifico

ID operazione:

GetV1CheckalertsCheckid

Elenca tutti gli avvisi per un controllo specifico.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Controllare l'ID	checkId	True	string	Identificatore di controllo.
Limite	limit		integer	Limitare il numero di risultati.
Number	page		number	Numero di pagina.
Da	from		date	Selezionare i documenti da questo timestamp UNIX (>= data). Il valore predefinito è ora - 6 ore.
Per	to		date	Selezionare gli avvisi fino a questo timestamp UNIX (< data). Il valore predefinito è 6 ore dopo.

Restituisce

Elementi

CheckAlertList

Elencare tutte le finestre di manutenzione

ID operazione:

GetV1Maintenancewindows

Elenca tutte le finestre di manutenzione nell'account.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Limite	limit		integer	Limitare il numero di risultati.
Number	page		number	Numero di pagina.

Restituisce

Elenco della finestra di manutenzione.

Elementi

MaintenanceWindowList

Elencare tutte le posizioni private

ID operazione:

GetV1Privatelocations

Elenca tutte le posizioni private nell'account.

Restituisce

Elementi

privateLocationsListSchema

Elencare tutte le variabili di ambiente

ID operazione:

GetV1Variables

Elenca tutte le variabili di ambiente correnti nell'account.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Limite	limit		integer	Limitare il numero di risultati.
Number	page		number	Numero di pagina.

Restituisce

Elementi

EnvironmentVariableList

Elencare tutti gli avvisi per l'account

ID operazione:

GetV1Checkalerts

Elenca tutti gli avvisi per l'account.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Limite	limit		integer	Limitare il numero di risultati.
Number	page		number	Numero di pagina.
Da	from		date	Selezionare i documenti da questo timestamp UNIX (>= data). Il valore predefinito è ora - 6 ore.
Per	to		date	Selezionare gli avvisi fino a questo timestamp UNIX (< data). Il valore predefinito è 6 ore dopo.

Restituisce

Elementi

CheckAlertList

Elencare tutti gli stati di controllo

ID operazione:

GetV1Checkstatuses

Mostra le informazioni sullo stato correnti per tutti i controlli nell'account. I record di stato del controllo vengono aggiornati continuamente man mano che vengono visualizzati i nuovi risultati del controllo.

Restituisce

Elementi

CheckStatusList

Elencare tutti i canali di avviso

ID operazione:

GetV1Alertchannels

Elenca tutti i canali di avviso configurati e i relativi controlli sottoscritti.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Limite	limit		integer	Limitare il numero di risultati.
Number	page		number	Numero di pagina.

Restituisce

Elementi

AlertChannelList

Elencare tutti i controlli

ID operazione:

GetV1Checks

Elenca tutti i controlli correnti nel tuo account.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Limite	limit		integer	Limitare il numero di risultati.
Number	page		number	Numero di pagina.
Filtro URL controllo API	apiCheckUrlFilterPattern		string	Filtra i risultati in base a una stringa contenuta nell'URL di un controllo API, ad esempio un dominio come www.myapp.com. Restituisce solo controlli API.

Restituisce

Elementi

CheckList

Elencare tutti i dashboard

ID operazione:

GetV1Dashboards

Elenca tutti i dashboard correnti nell'account.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Limite	limit		integer	Limitare il numero di risultati.
Number	page		number	Numero di pagina.

Restituisce

Elementi

DashboardsList

Elencare tutti i frammenti di codice

ID operazione:

GetV1Snippets

Elenca tutti i frammenti di codice correnti nell'account.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Limite	limit		integer	Limitare il numero di risultati.
Number	page		number	Numero di pagina.

Restituisce

Elementi

SnippetList

Elencare tutti i gruppi di controllo

ID operazione:

GetV1Checkgroups

Elenca tutti i gruppi di controllo correnti nell'account. La proprietà checks è una matrice di controlli UUID per un riferimento pratico. È di sola lettura e non è possibile usarlo per aggiungere controlli a un gruppo.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Limite	limit		integer	Limitare il numero di risultati.
Number	page		number	Numero di pagina.

Restituisce

Elementi

CheckGroupList

Eliminare il trigger check

ID operazione:

DeleteV1TriggersChecksCheckid

Elimina il trigger check.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Controllare l'ID	checkId	True	string	Identificatore di controllo.

Eliminare il trigger del gruppo di controllo

ID operazione:

DeleteV1TriggersCheckgroupsGroupid

Elimina il trigger check groups.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Gruppo	groupId	True	integer	Identificatore del gruppo.

Eliminare un canale di avviso

ID operazione:

DeleteV1AlertchannelsId

Rimuove definitivamente un canale di avviso.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	integer	Identificatore.

Eliminare un controllo

ID operazione:

DeleteV1ChecksId

Rimuove definitivamente un'API o un controllo del browser e tutti i relativi dati sullo stato e sui risultati correlati.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	string	Identificatore.

Eliminare un dashboard

ID operazione:

DeleteV1DashboardsDashboardid

Rimuove definitivamente un dashboard.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	dashboardId	True	string	Identificatore del dashboard.

Eliminare un frammento di codice

ID operazione:

DeleteV1SnippetsId

Rimuove definitivamente un frammento di codice.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	integer	Identificatore.

Eliminare un gruppo di controllo

ID operazione:

DeleteV1CheckgroupsId

Rimuove definitivamente un gruppo di controlli. Non è possibile eliminare un gruppo di controllo se contiene ancora controlli.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	integer	Identificatore.

Eliminare una finestra di manutenzione

ID operazione:

DeleteV1MaintenancewindowsId

Rimuove definitivamente una finestra di manutenzione.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	integer	Identificatore.

Eliminare una variabile di ambiente

ID operazione:

DeleteV1VariablesKey

Rimuove definitivamente una variabile di ambiente. Usa il campo chiave come identificatore per l'eliminazione.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Key	key	True	string	Tasto.

Genera un report con statistiche di aggregazione per i controlli e i gruppi di controllo

ID operazione:

GetV1Reporting

Genera un report con statistiche aggregate per tutti i controlli o un set filtrato di controlli in un intervallo di tempo specificato.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Da	from		date	Ora di inizio personalizzata della finestra di report in formato timestamp unix. L'impostazione di un oggetto personalizzato da timestamp sostituisce l'uso di qualsiasi presetWindow.
Per	to		date	Ora di fine personalizzata della finestra di report in formato timestamp unix. L'impostazione di un oggetto personalizzato su timestamp sostituisce l'uso di qualsiasi presetWindow.
Finestra preimpostato	presetWindow		string	Le finestre di report predefinite vengono usate per generare rapidamente report in finestre di uso comune. Può essere sottoposto a override usando un oggetto personalizzato da e verso il timestamp.
Filtra per tag	filterByTags		array	Usare i tag per filtrare i controlli che si desidera visualizzare nel report.
Disattivato	deactivated		boolean	Controlli del filtro in base allo stato attivato.

Restituisce

Elementi

ReportingList

Genera un report personalizzabile per tutte le metriche di controllo del browser

ID operazione:

GetV2ReportingBrowserchecksId

Genera un report con statistiche aggregate o non aggregate per un controllo browser specifico in un intervallo di tempo specificato.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	string	Identificatore.
Da	from		date	Ora di inizio personalizzata della finestra di report in formato timestamp unix. L'impostazione di un oggetto personalizzato da timestamp sostituisce l'uso di qualsiasi presetWindow.
Per	to		date	Ora di fine personalizzata della finestra di report in formato timestamp unix. L'impostazione di un oggetto personalizzato su timestamp sostituisce l'uso di qualsiasi presetWindow.
Finestra preimpostato	presetWindow		string	Le finestre di report predefinite vengono usate per generare rapidamente report in finestre di uso comune. Può essere sottoposto a override usando un oggetto personalizzato da e verso il timestamp.
Intervallo aggregazione	aggregationInterval		number	Intervallo di tempo da usare per l'aggregazione delle metriche in minuti. Ad esempio, cinque minuti sono 300, 24 ore è 1440.
Raggruppa per	groupBy		string	Determina la modalità di raggruppamento dei dati della serie.
Filtra per stato	filterByStatus		array	Usare lo stato per filtrare i dati dei risultati del controllo che hanno esito negativo o esito positivo.
Metriche	metrics		array	opzioni delle metriche per i controlli del browser.

Restituisce

Attributi.

Attributes

object

Generare una nuova chiave API per una posizione privata

ID operazione:

PostV1PrivatelocationsIdKeys

Crea una chiave API nella posizione privata.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	string	Identificatore.

Restituisce

Corpo

privateLocationKeys

Mostra i dettagli per un runtime specifico

ID operazione:

GetV1RuntimesId

Mostra i dettagli di tutti i pacchetti NPM inclusi e la relativa versione per un runtime specifico.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	string	Identificatore.

Restituisce

Corpo

Runtime

Notifica di stato del gruppo

ID operazione:

GetV1BadgesGroupsGroupid

Ottenere il badge di stato del gruppo.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Gruppo	groupId	True	integer	Identificatore del gruppo.
Style	style		string	Stile.
Tema	theme		string	Tema.
Tempo di risposta	responseTime		boolean	Tempo di risposta.

Restituisce

response

string

Ottenere il badge di stato del controllo

ID operazione:

GetV1BadgesChecksCheckid

Ottenere il badge di stato del controllo.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Controllare l'ID	checkId	True	string	Identificatore di controllo.
Style	style		string	Stile.
Tema	theme		string	Tema.
Tempo di risposta	responseTime		boolean	Tempo di risposta.

Restituisce

response

string

Ottenere il trigger check

ID operazione:

GetV1TriggersChecksCheckid

Trova il trigger check.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Controllare l'ID	checkId	True	string	Identificatore di controllo.

Restituisce

Corpo

CheckTrigger

Ottenere il trigger del gruppo di controllo

ID operazione:

GetV1TriggersCheckgroupsGroupid

Trova il trigger del gruppo di controllo.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Gruppo	groupId	True	integer	Identificatore del gruppo.

Restituisce

Corpo

CheckGroupTrigger

Ottenere le metriche di integrità della posizione privata da un intervallo di tempo

ID operazione:

GetV1PrivatelocationsIdMetrics

Ottenere le metriche di integrità della posizione privata da un intervallo di tempo.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	string	Identificatore.
Da	from	True	date	Selezionare le metriche a partire da questo timestamp UNIX. Deve essere inferiore a 15 giorni fa.
Per	to	True	date	Selezionare le metriche fino a questo timestamp UNIX.

Restituisce

Corpo

privateLocationsMetricsHistoryResponseSchema

Recuperare i dettagli dello stato di controllo

ID operazione:

GetV1CheckstatusesCheckid

Mostra le informazioni sullo stato correnti per un controllo specifico.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Controllare l'ID	checkId	True	string	Identificatore di controllo.

Restituisce

Corpo

CheckStatus

Recuperare tutti i controlli in un gruppo specifico con le impostazioni di gruppo applicate

ID operazione:

GetV1CheckgroupsIdChecks

Elenca tutti i controlli in un gruppo di controllo specifico con le impostazioni di gruppo applicate.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	integer	Identificatore.
Limite	limit		integer	Limitare il numero di risultati.
Number	page		number	Numero di pagina.

Restituisce

Elementi

Model8

Recuperare un'archiviazione in un gruppo specifico con le impostazioni di gruppo applicate

ID operazione:

GetV1CheckgroupsGroupidChecksCheckid

Mostra i dettagli di un controllo in un gruppo di controllo specifico con le impostazioni del gruppo applicate.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Gruppo	groupId	True	integer	Identificatore del gruppo.
Controllare l'ID	checkId	True	string	Identificatore di controllo.

Restituisce

Corpo

CheckGroupCheck

Recuperare un canale di avviso

ID operazione:

GetV1AlertchannelsId

Mostra i dettagli di un canale di avviso specifico.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	integer	Identificatore.

Restituisce

Corpo

AlertChannel

Recuperare un controllo

ID operazione:

GetV1ChecksId

Mostra i dettagli di un'API o di un controllo del browser specifico.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	string	Identificatore.

Restituisce

Corpo

Check

Recuperare un frammento di codice

ID operazione:

GetV1SnippetsId

Mostra i dettagli di un frammento specifico.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	integer	Identificatore.

Restituisce

Corpo

Snippet

Recuperare un gruppo di controllo

ID operazione:

GetV1CheckgroupsId

Mostra i dettagli di un gruppo di controllo specifico.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	integer	Identificatore.

Restituisce

Corpo

CheckGroup

Recuperare un risultato del controllo

ID operazione:

GetV1CheckresultsCheckidCheckresultid

Mostra i dettagli di un risultato di controllo specifico.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Controllare l'ID	checkId	True	string	Identificatore di controllo.
Controllare l'ID risultato	checkResultId	True	string	Identificatore del risultato del controllo.

Restituisce

Corpo

CheckResult

Recuperare una finestra di manutenzione

ID operazione:

GetV1MaintenancewindowsId

Mostra i dettagli di una finestra di manutenzione specifica.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	integer	Identificatore.

Restituisce

Corpo

MaintenanceWindow

Recuperare una posizione privata

ID operazione:

GetV1PrivatelocationsId

Mostra i dettagli di una posizione privata specifica.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	string	Identificatore.

Restituisce

Corpo

privatelocationschema

Recuperare una variabile di ambiente

ID operazione:

GetV1VariablesKey

Mostra i dettagli di una variabile di ambiente specifica. Usa il campo chiave per la selezione.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Key	key	True	string	Tasto.

Restituisce

Corpo

EnvironmentVariable

Rimuovere una chiave API esistente per una posizione privata

ID operazione:

DeleteV1PrivatelocationsIdKeysKeyid

Rimuove definitivamente una chiave API da una posizione privata.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	string	Identificatore.
ID chiave	keyId	True	string	Identificatore di chiave.

Rimuovere una posizione privata

ID operazione:

DeleteV1PrivatelocationsId

Rimuove definitivamente una posizione privata.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Documento d'identità	id	True	string	Identificatore.

Definizioni

AlertChannelConfig

Configurazione del canale di avviso.

Nome	Percorso	Tipo	Descrizione
Configurazione canale di avviso		object	Configurazione del canale di avviso.

AlertChanelSubscription

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	number	Identificatore.
Controllare l'ID	checkId	guid	Identificatore di controllo.
ID del Gruppo	groupId	number	Identificatore del gruppo.
Attivato	activated	boolean	Se attivato.

AlertChanelSubscriptionList

Tutti i controlli sono stati sottoscritti per questo canale.

Nome	Percorso	Tipo	Descrizione
Elementi		AlertChanelSubscription

AlertChannel

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	number	Identificatore.
TIPO	type	string	Tipo di canale di avviso, ad esempio EMAIL o SLACK.
Configurazione canale di avviso	config	AlertChannelConfig	Configurazione del canale di avviso.
Elenco sottoscrizioni canale di avviso	subscriptions	AlertChanelSubscriptionList	Tutti i controlli sono stati sottoscritti per questo canale.
Invia ripristino	sendRecovery	boolean	Indica se inviare il ripristino.
Errore di invio	sendFailure	boolean	Indica se l'errore di invio.
Invio danneggiato	sendDegraded	boolean	Indica se l'invio è danneggiato.
Scadenza SSL	sslExpiry	boolean	Determina se un avviso deve essere inviato per i certificati SSL in scadenza.
Soglia di scadenza SSL	sslExpiryThreshold	integer	In quale momento iniziare a inviare avvisi sui certificati SSL.
Creato all'indirizzo	created_at	date-time	Al momento della creazione.
Aggiornato all'indirizzo	updated_at	date-time	Quando viene aggiornato all'indirizzo.

AlertChannelList

Nome	Percorso	Tipo	Descrizione
Elementi		AlertChannel

CheckAlert

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	string	Identificatore univoco dell'avviso.
Nome	name	string	Nome del controllo.
Controllare l'ID	checkId	string	Identificatore del controllo a cui appartiene l'avviso.
Tipo di avviso	alertType	string	Tipo di avviso.
Check Type	checkType	string	Tipo del controllo.
Percorso di esecuzione	runLocation	string	Da quale posizione del data center è stato attivato questo avviso di controllo.
Tempo di risposta	responseTime	number	Descrive il tempo necessario per eseguire parti pertinenti di questo controllo. Qualsiasi tempo di sistema timer di installazione necessario per avviare l'esecuzione di questo controllo nel back-end Checkly non fa parte di questo.
Errore	error	string	Eventuali messaggi di errore specifici che fanno parte del controllo non riuscito che attiva l'avviso.
Codice di stato	statusCode	string	Codice di stato della risposta. Si applica solo ai controlli API.
Creato all'indirizzo	created_at	date	Data e ora di creazione dell'avviso di controllo.
Attività iniziali	startedAt	date	Data e ora di inizio dell'avviso di controllo.

CheckAlertList

Nome	Percorso	Tipo	Descrizione
Elementi		CheckAlert

CheckGroupTagList

Tag per organizzare e filtrare i controlli.

Nome	Percorso	Tipo	Descrizione
Elementi		string

CheckGroupLocationList

Matrice di una o più posizioni del data center in cui eseguire i controlli.

Nome	Percorso	Tipo	Descrizione
Elementi		string

KeyValue

Nome	Percorso	Tipo	Descrizione
Key	key	string	Tasto.
Value	value	string	Valore.
Bloccato	locked	boolean	Se bloccato.

HeaderList

Nome	Percorso	Tipo	Descrizione
Elementi		KeyValue

QueryParameterList

Nome	Percorso	Tipo	Descrizione
Elementi		KeyValue

Asserzione

Nome	Percorso	Tipo	Descrizione
Fonte	source	string	Origine.
Proprietà	property	string	Proprietà .
Comparison	comparison	string	Confronto.
Obiettivo	target	string	Destinazione.

AssertionList

Vedere la documentazione principale di Checkly sulle asserzioni per valori specifici, ad esempio espressioni regolari e descrittori di percorso JSON che è possibile usare nel campo della proprietà.

Nome	Percorso	Tipo	Descrizione
Elementi		Assertion

BasicAuth

Nome	Percorso	Tipo	Descrizione
Nome utente	username	string	Nome utente.
Parola chiave	password	string	Password.

CheckGroupAPICheckDefaults

Nome	Percorso	Tipo	Descrizione
URL	url	string	URL di base per questo gruppo a cui è possibile fare riferimento con la variabile {{GROUP_BASE_URL}} in tutti i controlli di gruppo.
headers	headers	HeaderList
queryParameters	queryParameters	QueryParameterList
Elenco asserzioni	assertions	AssertionList	Vedere la documentazione principale di Checkly sulle asserzioni per valori specifici, ad esempio espressioni regolari e descrittori di percorso JSON che è possibile usare nel campo della proprietà.
basicAuth	basicAuth	BasicAuth

CheckGroupBrowserCheckDefaults

Il browser del gruppo di controllo controlla le impostazioni predefinite.

Nome	Percorso	Tipo	Descrizione
Controlla impostazioni predefinite del browser di gruppo		object	Il browser del gruppo di controllo controlla le impostazioni predefinite.

EnvironmentVariable

Nome	Percorso	Tipo	Descrizione
Key	key	string	Chiave della variabile di ambiente (questo valore non può essere modificato).
Value	value	string	Valore della variabile di ambiente.
Bloccato	locked	boolean	Usato solo nell'interfaccia utente per nascondere il valore come una password.

EnvironmentVariableList

Nome	Percorso	Tipo	Descrizione
Elementi		EnvironmentVariable

AlertSettingsRunBasedEscalation

Nome	Percorso	Tipo	Descrizione
Soglia di esecuzione non riuscita	failedRunThreshold	number	Dopo il numero di controlli consecutivi non riusciti che devono essere inviati una notifica di avviso.

AlertSettingsTimeBasedEscalation

Nome	Percorso	Tipo	Descrizione
Soglia di errore minuti	minutesFailingThreshold	number	Dopo quanti minuti dopo l'avvio di un controllo ha esito negativo, deve essere inviato un avviso.

AlertSettingsReminders

Nome	Percorso	Tipo	Descrizione
Importo	amount	number	Numero di promemoria da inviare dopo la notifica di avviso iniziale.
Intervallo	interval	number	A quale intervallo devono essere inviati i promemoria.

AlertSettingsSSLCertificates

[DEPRECATO] sslCertificates è deprecato e non viene più usato. Ignorarlo, verrà rimosso in una versione futura.

Nome	Percorso	Tipo	Descrizione
Enabled	enabled	boolean	Determina se le notifiche di avviso devono essere inviate per i certificati SSL in scadenza.
Soglia avviso	alertThreshold	integer	In quale momento iniziare a inviare avvisi sui certificati SSL.

CheckGroupAlertSettings

Impostazioni degli avvisi.

Nome	Percorso	Tipo	Descrizione
Tipo di escalation	escalationType	string	Determina il tipo di escalation da usare.
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
Promemoria	reminders	AlertSettingsReminders
Certificati SSL delle impostazioni degli avvisi	sslCertificates	AlertSettingsSSLCertificates	[DEPRECATO] sslCertificates è deprecato e non viene più usato. Ignorarlo, verrà rimosso in una versione futura.

Model1

Sottoscrizione del canale di avviso.

Nome	Percorso	Tipo	Descrizione
ID canale di avviso	alertChannelId	number	Identificatore del canale di avviso.
Attivato	activated	boolean	Se attivato.

AlertChannelSubscriptionCreateList

Elenco delle sottoscrizioni del canale di avviso.

Nome	Percorso	Tipo	Descrizione
Sottoscrizione del canale di avviso		Model1	Sottoscrizione del canale di avviso.

privateLocations

Matrice di una o più posizioni private in cui eseguire il controllo.

Nome	Percorso	Tipo	Descrizione
Elementi		string

CheckGroup

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	number	Identificatore.
Nome	name	string	Nome del gruppo di controllo.
Attivato	activated	boolean	Determina se i controlli nel gruppo sono in esecuzione o meno.
Disattivato	muted	boolean	Determina se le notifiche verranno inviate quando un'archiviazione in questo gruppo ha esito negativo e/o viene ripristinata.
Controlla elenco tag di gruppo	tags	CheckGroupTagList	Tag per organizzare e filtrare i controlli.
Controlla elenco località gruppo	locations	CheckGroupLocationList	Matrice di una o più posizioni del data center in cui eseguire i controlli.
Concurrency	concurrency	number	Determina il numero di controlli richiamati simultaneamente durante l'attivazione di un gruppo di controllo da CI/CD o tramite l'API.
apiCheckDefaults	apiCheckDefaults	CheckGroupAPICheckDefaults
Controlla impostazioni predefinite del browser di gruppo	browserCheckDefaults	CheckGroupBrowserCheckDefaults	Il browser del gruppo di controllo controlla le impostazioni predefinite.
environmentVariables	environmentVariables	EnvironmentVariableList
Verifica doppia	doubleCheck	boolean	L'impostazione di questa proprietà su true attiverà un nuovo tentativo quando un controllo non riesce dall'area non riuscita e un'altra area selezionata in modo casuale prima di contrassegnare il controllo come non riuscito.
Usare le impostazioni di avviso globali	useGlobalAlertSettings	boolean	Se true, verrà usata l'impostazione di avviso a livello di account, non l'impostazione di avviso definita in questo gruppo di controllo.
Controllare le impostazioni di avviso del gruppo	alertSettings	CheckGroupAlertSettings	Impostazioni degli avvisi.
Elenco di creazione della sottoscrizione del canale di avviso	alertChannelSubscriptions	AlertChannelSubscriptionCreateList	Elenco delle sottoscrizioni del canale di avviso.
ID frammento di codice di installazione	setupSnippetId	number	Riferimento di identificatore a un frammento di codice da usare nella fase di installazione di un controllo API in questo gruppo.
ID frammento di codice di disinstallazione	tearDownSnippetId	number	Riferimento di identificatore a un frammento di codice da usare nella fase di disinstallazione di un controllo API in questo gruppo.
Script di installazione locale	localSetupScript	string	Parte valida di Node.js codice da eseguire nella fase di installazione di un controllo API in questo gruppo.
Script di disinstallazione locale	localTearDownScript	string	Parte valida di Node.js codice da eseguire nella fase di disinstallazione di un controllo API in questo gruppo.
Runtime ID	runtimeId	string	La versione di runtime, ovvero il set fisso di dipendenze di runtime, usato per eseguire i controlli in questo gruppo.
Posizioni private	privateLocations	privateLocations	Matrice di una o più posizioni private in cui eseguire il controllo.
Creato all'indirizzo	created_at	date	Al momento della creazione.
Aggiornato all'indirizzo	updated_at	date-time	Quando viene aggiornato all'indirizzo.

CheckGroupList

Nome	Percorso	Tipo	Descrizione
Elementi		CheckGroup

CheckLocationList

Matrice di una o più posizioni del data center in cui eseguire questo controllo.

Nome	Percorso	Tipo	Descrizione
Elementi		string

CheckTagList

Tag per organizzare e filtrare i controlli.

Nome	Percorso	Tipo	Descrizione
Elementi		string

CheckAlertSettings

Impostazioni degli avvisi.

Nome	Percorso	Tipo	Descrizione
Tipo di escalation	escalationType	string	Determina il tipo di escalation da usare.
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
Promemoria	reminders	AlertSettingsReminders
Certificati SSL delle impostazioni degli avvisi	sslCertificates	AlertSettingsSSLCertificates	[DEPRECATO] sslCertificates è deprecato e non viene più usato. Ignorarlo, verrà rimosso in una versione futura.

CheckAlertChannelSubscription

Nome	Percorso	Tipo	Descrizione
ID canale di avviso	alertChannelId	number	Identificatore del canale di avviso.
Attivato	activated	boolean	Se attivato.

CheckAlertChannelSubscriptionList

Nome	Percorso	Tipo	Descrizione
Elementi		CheckAlertChannelSubscription

CheckRequest

Richiesta di controllo.

Nome	Percorso	Tipo	Descrizione
Controlla richiesta		object	Richiesta di controllo.

CheckEnvironmentVariableList

Coppie chiave/valore per l'impostazione delle variabili di ambiente durante l'esecuzione del controllo. Questi sono rilevanti solo per i controlli del browser. Usare le variabili di ambiente globali quando possibile.

Nome	Percorso	Tipo	Descrizione
Elementi		EnvironmentVariable

CheckAlertEmail

Nome	Percorso	Tipo	Descrizione
Address	address	string	Indirizzo.

CheckAlertEmailList

Nome	Percorso	Tipo	Descrizione
Elementi		CheckAlertEmail

Model4

Nome	Percorso	Tipo	Descrizione
Elementi		KeyValue

Model5

Nome	Percorso	Tipo	Descrizione
Elementi		KeyValue

CheckAlertWebhook

Nome	Percorso	Tipo	Descrizione
Nome	name	string	Nome.
URL	url	string	Indirizzo URL.
Metodo	method	string	Metodo .
headers	headers	Model4
queryParameters	queryParameters	Model5

CheckAlertWebhookList

Nome	Percorso	Tipo	Descrizione
Elementi		CheckAlertWebhook

CheckAlertSlack

Nome	Percorso	Tipo	Descrizione
URL	url	string	Indirizzo URL.

CheckAlertSlackList

Nome	Percorso	Tipo	Descrizione
Elementi		CheckAlertSlack

CheckAlertSMS

Nome	Percorso	Tipo	Descrizione
Number	number	string	Numero.
Nome	name	string	Nome.

CheckAlertSMSList

Nome	Percorso	Tipo	Descrizione
Elementi		CheckAlertSMS

CheckAlertChannels

Nome	Percorso	Tipo	Descrizione
posta elettronica	email	CheckAlertEmailList
Webhook	webhook	CheckAlertWebhookList
lasco	slack	CheckAlertSlackList
messaggio di testo	sms	CheckAlertSMSList

CheckGroupCheck

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	string	Identificatore.
Nome	name	string	Nome del controllo.
Attivato	activated	boolean	Determina se il controllo è in esecuzione o meno.
Disattivato	muted	boolean	Determina se le notifiche verranno inviate quando un controllo ha esito negativo e/o viene ripristinato.
Verifica doppia	doubleCheck	boolean	L'impostazione di questa proprietà su true attiverà un nuovo tentativo quando un controllo non riesce dall'area non riuscita e un'altra area selezionata in modo casuale prima di contrassegnare il controllo come non riuscito.
Dovrebbe avere esito negativo	shouldFail	boolean	Consente di invertire il comportamento di quando un controllo viene considerato non riuscita. Consente di convalidare lo stato di errore, ad esempio 404.
Controlla elenco località	locations	CheckLocationList	Matrice di una o più posizioni del data center in cui eseguire questo controllo.
Controlla elenco tag	tags	CheckTagList	Tag per organizzare e filtrare i controlli.
Controllare le impostazioni degli avvisi	alertSettings	CheckAlertSettings	Impostazioni degli avvisi.
Usare le impostazioni di avviso globali	useGlobalAlertSettings	boolean	Se true, verrà usata l'impostazione di avviso a livello di account, non l'impostazione dell'avviso definita in questa verifica.
ID del Gruppo	groupId	number	L'identificatore del gruppo di controllo di cui fa parte questo controllo.
Ordine di gruppo	groupOrder	number	Posizione di questo controllo in un gruppo di controllo. Determina in quali controlli degli ordini vengono eseguiti quando un gruppo viene attivato dall'API o da CI/CD.
Runtime ID	runtimeId	string	La versione di runtime, ovvero il set fisso di dipendenze di runtime, usato per eseguire questo controllo.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Check Type	checkType	string	Tipo del controllo.
Frequenza	frequency	integer	Frequenza con cui il controllo deve essere eseguito in minuti.
Offset frequenza	frequencyOffset	integer	Offset della frequenza.
Controlla richiesta	request	CheckRequest	Richiesta di controllo.
Sceneggiatura	script	string	Script.
Controllare l'elenco delle variabili di ambiente	environmentVariables	CheckEnvironmentVariableList	Coppie chiave/valore per l'impostazione delle variabili di ambiente durante l'esecuzione del controllo. Questi sono rilevanti solo per i controlli del browser. Usare le variabili di ambiente globali quando possibile.
ID frammento di codice di installazione	setupSnippetId	number	Riferimento di identificatore a un frammento di codice da usare nella fase di installazione di un controllo API.
ID frammento di codice di disinstallazione	tearDownSnippetId	number	Riferimento di identificatore a un frammento di codice da usare nella fase di disinstallazione di un controllo API.
Script di installazione locale	localSetupScript	string	Parte valida di Node.js codice da eseguire nella fase di installazione.
Script di disinstallazione locale	localTearDownScript	string	Parte valida di Node.js codice da eseguire nella fase di disinstallazione.
Tempo di risposta danneggiato	degradedResponseTime	number	Tempo di risposta in millisecondi in cui un controllo deve essere considerato danneggiato.
Tempo massimo di risposta	maxResponseTime	number	Tempo di risposta in millisecondi in cui un controllo deve essere considerato non riuscito.
alertChannels	alertChannels	CheckAlertChannels
Posizioni private	privateLocations	privateLocations	Matrice di una o più posizioni private in cui eseguire il controllo.
Creato all'indirizzo	created_at	date	Al momento della creazione.
Aggiornato all'indirizzo	updated_at	date-time	Quando viene aggiornato all'indirizzo.

Model8

Nome	Percorso	Tipo	Descrizione
Elementi		CheckGroupCheck

Asserzioni

Elenco di asserzioni di controllo API.

Nome	Percorso	Tipo	Descrizione
Elementi		string

headers

Intestazioni.

Nome	Percorso	Tipo	Descrizione
Headers		object	Intestazioni.

params

Parametri.

Nome	Percorso	Tipo	Descrizione
Parametri		object	Parametri.

request

Richiesta per l'API.

Nome	Percorso	Tipo	Descrizione
method	method	string
URL	url	string
data	data	string
Headers	headers	headers	Intestazioni.
Parametri	params	params	Parametri.

Tempi

Intervalli.

Nome	Percorso	Tipo	Descrizione
Tempi		object	Intervalli.

timingPhases

Fasi di temporizzazione.

Nome	Percorso	Tipo	Descrizione
Fasi di temporizzazione		object	Fasi di temporizzazione.

response

Risposta API.

Nome	Percorso	Tipo	Descrizione
stato	status	number	Stato.
Testo stato	statusText	string	Testo dello stato.
Corpo	body	string	Il corpo.
Headers	headers	headers	Intestazioni.
Tempi	timings	timings	Intervalli.
Fasi di temporizzazione	timingPhases	timingPhases	Fasi di temporizzazione.

jobLog

Log del processo.

Nome	Percorso	Tipo	Descrizione
Log processi		object	Log del processo.

jobAssets

Asset generati dall'esecuzione del controllo.

Nome	Percorso	Tipo	Descrizione
Elementi		string

CheckResultAPI

Dati di risposta per un controllo API.

Nome	Percorso	Tipo	Descrizione
Assertions	assertions	assertions	Elenco di asserzioni di controllo API.
Richiesta	request	request	Richiesta per l'API.
Risposta	response	response	Risposta API.
Errore di richiesta	requestError	string	Descrive se si è verificato un errore nella richiesta.
Log processi	jobLog	jobLog	Log del processo.
Asset di processo	jobAssets	jobAssets	Asset generati dall'esecuzione del controllo.

errori

Elenco di errori nell'esecuzione del controllo.

Nome	Percorso	Tipo	Descrizione
Elementi		string

Model9

Controllare i risultati del log di esecuzione.

Nome	Percorso	Tipo	Descrizione
Elementi		string

traceSummary

Riepilogo della traccia.

Nome	Percorso	Tipo	Descrizione
Riepilogo traccia		object	Riepilogo della traccia.

Pagine

Elenco di pagine usate nell'esecuzione del controllo.

Nome	Percorso	Tipo	Descrizione
Elementi		string

CheckResultBrowser

Dati della risposta per un controllo del browser.

Nome	Percorso	Tipo	Descrizione
TIPO	type	string	Tipo di framework usato dal controllo.
Errors	errors	errors	Elenco di errori nell'esecuzione del controllo.
Ora di fine	endTime	number	Ora di fine dell'esecuzione del controllo.
Ora di avvio	startTime	number	Ora di inizio dell'esecuzione del controllo.
Versione di runtime	runtimeVersion	string	Versione di runtime attiva.
Controllare il log di esecuzione	jobLog	Model9	Controllare i risultati del log di esecuzione.
Asset di processo	jobAssets	jobAssets	Asset generati dall'esecuzione del controllo.
Riepilogo traccia	traceSummary	traceSummary	Riepilogo della traccia.
Pagine	pages	pages	Elenco di pagine usate nell'esecuzione del controllo.

CheckResult

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	string	Identificatore univoco di questo risultato.
Nome	name	string	Nome del controllo.
Controllare l'ID	checkId	string	Identificatore del controllo.
Errori	hasFailures	boolean	Descrive se si è verificato un errore durante l'esecuzione del controllo. Questo è l'obiettivo principale per valutare il comportamento dell'API o del controllo del browser. Le asserzioni che hanno esito negativo, timeout o script non riusciti risolvono tutti questo valore in modo che sia true.
Contiene errori	hasErrors	boolean	Descrive se si è verificato un errore interno nel back-end di Checkly. Deve essere false in quasi tutti i casi.
È danneggiato	isDegraded	boolean	Un controllo è danneggiato se supera il limite di riduzione impostato dal campo degradedResponseTime nel controllo. Si applica solo ai controlli API.
Over Max Response Time	overMaxResponseTime	boolean	Impostare su true se il tempo di risposta supera il limite impostato dal campo maxResponseTime nel controllo. Si applica solo ai controlli API.
Percorso di esecuzione	runLocation	string	Posizione del data center da cui ha avuto origine il risultato del controllo.
Attività iniziali	startedAt	date-time	Oggetto avviato all'ora.
Si è fermato a	stoppedAt	date-time	L'oggetto è stato arrestato all'ora.
Creato all'indirizzo	created_at	date-time	Al momento della creazione.
Tempo di risposta	responseTime	number	Descrive il tempo necessario per eseguire parti pertinenti di questo controllo. Qualsiasi tempo di sistema timer di installazione necessario per avviare l'esecuzione di questo controllo nel back-end Checkly non fa parte di questo.
Check Result API	apiCheckResult	CheckResultAPI	Dati di risposta per un controllo API.
Risultato controllo browser	browserCheckResult	CheckResultBrowser	Dati della risposta per un controllo del browser.
Controllare l'ID esecuzione	checkRunId	number	Identificatore dell'esecuzione del controllo specifica che ha creato il risultato del controllo.
Tentativi	attempts	number	Frequenza con cui è stato eseguito il tentativo di verifica. Questo valore sarà maggiore di 0 quando il controllo doppio è abilitato.

CheckResultList

Nome	Percorso	Tipo	Descrizione
Elementi		CheckResult

CheckStatus

Nome	Percorso	Tipo	Descrizione
Nome	name	string	Nome del controllo.
Controllare l'ID	checkId	string	Identificatore del controllo a cui appartiene questo stato.
Errori	hasFailures	boolean	Descrive se il controllo non riesce. Se una delle asserzioni per un controllo API ha esito negativo, questo valore è true. Se un controllo del browser ha esito negativo per qualsiasi motivo, questo è vero.
Contiene errori	hasErrors	boolean	Descrive se a causa di un errore al di fuori del normale funzionamento questo controllo ha esito negativo. Questo dovrebbe essere estremamente raro e solo quando si verifica un errore nel back-end Checkly.
È danneggiato	isDegraded	boolean	Un controllo è danneggiato se supera il limite di riduzione impostato dal campo degradedResponseTime nel controllo. Si applica solo ai controlli API.
Esecuzione più lunga	longestRun	number	Tempo di risposta più lungo mai registrato per questo controllo.
Esecuzione più breve	shortestRun	number	Tempo di risposta più breve mai registrato per questo controllo.
Posizione ultima esecuzione	lastRunLocation	string	Posizione in cui è stata eseguita l'ultima esecuzione di questo controllo.
Last Check Run ID	lastCheckRunId	string	Identificatore di incremento univoco per ogni esecuzione del controllo.
Giorni SSL rimanenti	sslDaysRemaining	number	Il numero di giorni rimanenti fino alla scadenza del certificato SSL corrente.
Creato all'indirizzo	created_at	date	Al momento della creazione.
Aggiornato all'indirizzo	updated_at	date-time	Quando viene aggiornato all'indirizzo.

CheckStatusList

Nome	Percorso	Tipo	Descrizione
Elementi		CheckStatus

Controlla

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	string	Identificatore.
Nome	name	string	Nome del controllo.
Attivato	activated	boolean	Determina se il controllo è in esecuzione o meno.
Disattivato	muted	boolean	Determina se le notifiche verranno inviate quando un controllo ha esito negativo e/o viene ripristinato.
Verifica doppia	doubleCheck	boolean	L'impostazione di questa proprietà su true attiverà un nuovo tentativo quando un controllo non riesce dall'area non riuscita e un'altra area selezionata in modo casuale prima di contrassegnare il controllo come non riuscito.
Dovrebbe avere esito negativo	shouldFail	boolean	Consente di invertire il comportamento di quando un controllo viene considerato non riuscita. Consente di convalidare lo stato di errore, ad esempio 404.
Controlla elenco località	locations	CheckLocationList	Matrice di una o più posizioni del data center in cui eseguire questo controllo.
Controlla elenco tag	tags	CheckTagList	Tag per organizzare e filtrare i controlli.
Controllare le impostazioni degli avvisi	alertSettings	CheckAlertSettings	Impostazioni degli avvisi.
Usare le impostazioni di avviso globali	useGlobalAlertSettings	boolean	Se true, verrà usata l'impostazione di avviso a livello di account, non l'impostazione dell'avviso definita in questa verifica.
ID del Gruppo	groupId	number	L'identificatore del gruppo di controllo di cui fa parte questo controllo.
Ordine di gruppo	groupOrder	number	Posizione di questo controllo in un gruppo di controllo. Determina in quali controlli degli ordini vengono eseguiti quando un gruppo viene attivato dall'API o da CI/CD.
Runtime ID	runtimeId	string	La versione di runtime, ovvero il set fisso di dipendenze di runtime, usato per eseguire questo controllo.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Check Type	checkType	string	Tipo del controllo.
Frequenza	frequency	integer	Frequenza con cui il controllo deve essere eseguito in minuti.
Offset frequenza	frequencyOffset	integer	Offset della frequenza.
Controlla richiesta	request	CheckRequest	Richiesta di controllo.
Sceneggiatura	script	string	Script.
Controllare l'elenco delle variabili di ambiente	environmentVariables	CheckEnvironmentVariableList	Coppie chiave/valore per l'impostazione delle variabili di ambiente durante l'esecuzione del controllo. Questi sono rilevanti solo per i controlli del browser. Usare le variabili di ambiente globali quando possibile.
ID frammento di codice di installazione	setupSnippetId	number	Riferimento di identificatore a un frammento di codice da usare nella fase di installazione di un controllo API.
ID frammento di codice di disinstallazione	tearDownSnippetId	number	Riferimento di identificatore a un frammento di codice da usare nella fase di disinstallazione di un controllo API.
Script di installazione locale	localSetupScript	string	Parte valida di Node.js codice da eseguire nella fase di installazione.
Script di disinstallazione locale	localTearDownScript	string	Parte valida di Node.js codice da eseguire nella fase di disinstallazione.
Tempo di risposta danneggiato	degradedResponseTime	number	Tempo di risposta in millisecondi in cui un controllo deve essere considerato danneggiato.
Tempo massimo di risposta	maxResponseTime	number	Tempo di risposta in millisecondi in cui un controllo deve essere considerato non riuscito.
alertChannels	alertChannels	CheckAlertChannels
Posizioni private	privateLocations	privateLocations	Matrice di una o più posizioni private in cui eseguire il controllo.
Creato all'indirizzo	created_at	date	Al momento della creazione.
Aggiornato all'indirizzo	updated_at	date-time	Quando viene aggiornato all'indirizzo.

Lista di controllo

Nome	Percorso	Tipo	Descrizione
Elementi		Check

Model14

Nome	Percorso	Tipo	Descrizione
Elementi		KeyValue

Model15

Nome	Percorso	Tipo	Descrizione
Elementi		KeyValue

Model16

Determina la richiesta che verrà eseguita la verifica.

Nome	Percorso	Tipo	Descrizione
method	method	string
URL	url	string	Indirizzo URL.
Seguire i reindirizzamenti	followRedirects	boolean	Indica se seguire i reindirizzamenti.
Ignorare SSL	skipSSL	boolean	Se ignorare SSL.
Corpo	body	string	Il corpo.
Tipo di corpo	bodyType	string	Tipo di corpo.
headers	headers	Model14
queryParameters	queryParameters	Model15
Elenco asserzioni	assertions	AssertionList	Vedere la documentazione principale di Checkly sulle asserzioni per valori specifici, ad esempio espressioni regolari e descrittori di percorso JSON che è possibile usare nel campo della proprietà.
basicAuth	basicAuth	BasicAuth

CheckAPI

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	string	Identificatore.
Nome	name	string	Nome del controllo.
Attivato	activated	boolean	Determina se il controllo è in esecuzione o meno.
Disattivato	muted	boolean	Determina se le notifiche verranno inviate quando un controllo ha esito negativo e/o viene ripristinato.
Verifica doppia	doubleCheck	boolean	L'impostazione di questa proprietà su true attiverà un nuovo tentativo quando un controllo non riesce dall'area non riuscita e un'altra area selezionata in modo casuale prima di contrassegnare il controllo come non riuscito.
Dovrebbe avere esito negativo	shouldFail	boolean	Consente di invertire il comportamento di quando un controllo viene considerato non riuscita. Consente di convalidare lo stato di errore, ad esempio 404.
Controlla elenco località	locations	CheckLocationList	Matrice di una o più posizioni del data center in cui eseguire questo controllo.
Controlla elenco tag	tags	CheckTagList	Tag per organizzare e filtrare i controlli.
Controllare le impostazioni degli avvisi	alertSettings	CheckAlertSettings	Impostazioni degli avvisi.
Usare le impostazioni di avviso globali	useGlobalAlertSettings	boolean	Se true, verrà usata l'impostazione di avviso a livello di account, non l'impostazione dell'avviso definita in questa verifica.
ID del Gruppo	groupId	number	L'identificatore del gruppo di controllo di cui fa parte questo controllo.
Ordine di gruppo	groupOrder	number	Posizione di questo controllo in un gruppo di controllo. Determina in quali controlli degli ordini vengono eseguiti quando un gruppo viene attivato dall'API o da CI/CD.
Runtime ID	runtimeId	string	La versione di runtime, ovvero il set fisso di dipendenze di runtime, usato per eseguire questo controllo.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Controlla richiesta	request	Model16	Determina la richiesta che verrà eseguita la verifica.
Frequenza	frequency	integer	Frequenza con cui il controllo deve essere eseguito in minuti.
Offset frequenza	frequencyOffset	integer	Usato per impostare i secondi per controllare le frequenze in meno di 1 minuti (solo per i controlli API) e distribuirne i controlli in un intervallo di tempo per le frequenze di oltre 1 minuto. Funziona come segue: i controlli con una frequenza pari a 0 possono avere un frequencyOffset pari a 10, 20 o 30, vale a dire che verranno eseguiti ogni 10, 20 o 30 secondi. I controlli con una frequenza inferiore a e uguale a 60 possono avere un frequencyOffset compreso tra 1 e un valore massimo in base alla formula Math.floor(frequency * 10), ad esempio per un controllo eseguito ogni 5 minuti il valore max frequencyOffset è 50. I controlli con una frequenza superiore a 60 possono avere un frequencyOffset compreso tra 1 e un valore massimo in base alla formula Math.ceil(frequency / 60), ad esempio per un controllo eseguito ogni 720 minuti, il valore max frequencyOffset è 12.
ID frammento di codice di disinstallazione	tearDownSnippetId	number	Riferimento di identificatore a un frammento di codice da usare nella fase di disinstallazione di un controllo API.
ID frammento di codice di installazione	setupSnippetId	number	Riferimento di identificatore a un frammento di codice da usare nella fase di installazione di un controllo API.
Script di installazione locale	localSetupScript	string	Parte valida di Node.js codice da eseguire nella fase di installazione.
Script di disinstallazione locale	localTearDownScript	string	Parte valida di Node.js codice da eseguire nella fase di disinstallazione.
Tempo di risposta danneggiato	degradedResponseTime	number	Tempo di risposta in millisecondi in cui un controllo deve essere considerato danneggiato.
Tempo massimo di risposta	maxResponseTime	number	Tempo di risposta in millisecondi in cui un controllo deve essere considerato non riuscito.
Posizioni private	privateLocations	privateLocations	Matrice di una o più posizioni private in cui eseguire il controllo.
Check Type	checkType	string	Tipo di controllo.
alertChannels	alertChannels	CheckAlertChannels
Creato all'indirizzo	created_at	date	Al momento della creazione.
Aggiornato all'indirizzo	updated_at	date-time	Quando viene aggiornato all'indirizzo.

CheckBrowser

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	string	Identificatore.
Nome	name	string	Nome del controllo.
Attivato	activated	boolean	Determina se il controllo è in esecuzione o meno.
Disattivato	muted	boolean	Determina se le notifiche verranno inviate quando un controllo ha esito negativo e/o viene ripristinato.
Verifica doppia	doubleCheck	boolean	L'impostazione di questa proprietà su true attiverà un nuovo tentativo quando un controllo non riesce dall'area non riuscita e un'altra area selezionata in modo casuale prima di contrassegnare il controllo come non riuscito.
Dovrebbe avere esito negativo	shouldFail	boolean	Consente di invertire il comportamento di quando un controllo viene considerato non riuscita. Consente di convalidare lo stato di errore, ad esempio 404.
Controlla elenco località	locations	CheckLocationList	Matrice di una o più posizioni del data center in cui eseguire questo controllo.
Controlla elenco tag	tags	CheckTagList	Tag per organizzare e filtrare i controlli.
Controllare le impostazioni degli avvisi	alertSettings	CheckAlertSettings	Impostazioni degli avvisi.
Usare le impostazioni di avviso globali	useGlobalAlertSettings	boolean	Se true, verrà usata l'impostazione di avviso a livello di account, non l'impostazione dell'avviso definita in questa verifica.
ID del Gruppo	groupId	number	L'identificatore del gruppo di controllo di cui fa parte questo controllo.
Ordine di gruppo	groupOrder	number	Posizione di questo controllo in un gruppo di controllo. Determina in quali controlli degli ordini vengono eseguiti quando un gruppo viene attivato dall'API o da CI/CD.
Runtime ID	runtimeId	string	La versione di runtime, ovvero il set fisso di dipendenze di runtime, usato per eseguire questo controllo.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Check Type	checkType	string	Tipo di controllo.
Frequenza	frequency	integer	Frequenza con cui il controllo deve essere eseguito in minuti.
Sceneggiatura	script	string	Una parte valida di Node.js codice Javascript che descrive un'interazione del browser con i framework Puppeteer o Playwright.
Posizioni private	privateLocations	privateLocations	Matrice di una o più posizioni private in cui eseguire il controllo.
alertChannels	alertChannels	CheckAlertChannels
Creato all'indirizzo	created_at	date	Al momento della creazione.
Aggiornato all'indirizzo	updated_at	date-time	Quando viene aggiornato all'indirizzo.

DashboardTagList

Elenco di uno o più tag che filtrano i controlli da visualizzare nel dashboard.

Nome	Percorso	Tipo	Descrizione
Elementi		string

Dashboard

Nome	Percorso	Tipo	Descrizione
Dominio personalizzato	customDomain	string	Un dominio utente personalizzato, ad esempio status.example.com. Vedere la documentazione sull'aggiornamento dell'utilizzo di DNS e SSL.
URL personalizzato	customUrl	string	Nome di sottodominio in checklyhq.com. Deve essere univoco per tutti gli utenti.
Logo	logo	string	URL che punta a un file di immagine.
Favicon	favicon	string	URL che punta a un file di immagine usato come favicon del dashboard.
Link	link	string	Collegamento URL da reindirizzare quando si fa clic sul logo del dashboard.
Header	header	string	Parte di testo visualizzata nella parte superiore del dashboard.
Description	description	string	Una parte di testo visualizzata sotto l'intestazione o il titolo del dashboard.
Larghezza	width	string	Determina se usare lo schermo intero o lo stato attivo al centro.
Frequenza	refreshRate	number	Frequenza con cui aggiornare il dashboard in pochi secondi.
Impaginare	paginate	boolean	Determina che la paginazione è attivata o disattivata.
Frequenza di impaginazione	paginationRate	number	Frequenza con cui attivare la paginazione in secondi.
Controlli per pagina	checksPerPage	number	Numero di controlli visualizzati per pagina.
Operatore Use And	useTagsAndOperator	boolean	Quando usare l'operatore AND per la ricerca di tag.
Nascondi tag	hideTags	boolean	Mostrare o nascondere i tag nel dashboard.
Elenco tag dashboard	tags	DashboardTagList	Elenco di uno o più tag che filtrano i controlli da visualizzare nel dashboard.
Dashboard ID	dashboardId	string	Identificatore del dashboard.

DashboardsList

Nome	Percorso	Tipo	Descrizione
Elementi		Dashboard

Posizione

Nome	Percorso	Tipo	Descrizione
Area geografica	region	string	Identificatore univoco di questa posizione.
Nome	name	string	Nome descrittivo di questa posizione.

LocationList

Nome	Percorso	Tipo	Descrizione
Elementi		Location

MaintenanceWindowTagList

I nomi della finestra di manutenzione controlli e gruppi devono essere applicati.

Nome	Percorso	Tipo	Descrizione
Elementi		string

Finestra di manutenzione

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	number	Identificatore della finestra di manutenzione.
Nome	name	string	Nome della finestra di manutenzione.
Elenco tag finestra di manutenzione	tags	MaintenanceWindowTagList	I nomi della finestra di manutenzione controlli e gruppi devono essere applicati.
Inizia da	startsAt	date	Data di inizio della finestra di manutenzione.
Termina in corrispondenza di	endsAt	date	Data di fine della finestra di manutenzione.
Intervallo ripetizione	repeatInterval	number	Intervallo di ripetizione della finestra di manutenzione dalla prima occorrenza.
Unità ripetizione	repeatUnit	string	Strategia di ripetizione per la finestra di manutenzione.
Ripeti termina in corrispondenza di	repeatEndsAt	date	Data di fine in cui la finestra di manutenzione deve interrompere la ripetizione.
Creato all'indirizzo	created_at	date	Data di creazione della finestra di manutenzione.
Aggiornato all'indirizzo	updated_at	date	Data dell'ultimo aggiornamento della finestra di manutenzione.

MaintenanceWindowList

Elenco della finestra di manutenzione.

Nome	Percorso	Tipo	Descrizione
Elementi		MaintenanceWindow

CheckAssignment

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	guid	Identificatore.
Controllare l'ID	checkId	guid	Identificatore del controllo.
ID percorso privato	privateLocationId	guid	Identificatore della posizione privata assegnata.

checkAssignments

Verifica che questa posizione privata sia stata assegnata.

Nome	Percorso	Tipo	Descrizione
Elementi		CheckAssignment

GroupAssignment

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	guid	Identificatore.
ID del Gruppo	groupId	number	Identificatore del gruppo.
ID percorso privato	privateLocationId	guid	Identificatore della posizione privata assegnata.

groupAssignments

Il gruppo a cui è stata assegnata la posizione privata.

Nome	Percorso	Tipo	Descrizione
Elementi		GroupAssignment

privateLocationKeys

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	guid	Identificatore.
Chiave non elaborata	rawKey	string	Chiave non elaborata.
Chiave mascherata	maskedKey	string	Valore della chiave mascherata.
Creato all'indirizzo	created_at	date	Al momento della creazione.
Aggiornato all'indirizzo	updated_at	date	Quando viene aggiornato all'indirizzo.

Chiavi

Nome	Percorso	Tipo	Descrizione
Elementi		privateLocationKeys

privatelocationschema

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	guid	Identificatore.
Nome	name	string	Nome assegnato alla posizione privata.
Nome slug	slugName	string	Nome di slug valido.
Icona	icon	string	Icona della posizione privata.
Creato all'indirizzo	created_at	date	Al momento della creazione.
Aggiornato all'indirizzo	updated_at	date	Quando viene aggiornato all'indirizzo.
Controllare le assegnazioni	checkAssignments	checkAssignments	Verifica che questa posizione privata sia stata assegnata.
Assegnazioni di gruppo	groupAssignments	groupAssignments	Il gruppo a cui è stata assegnata la posizione privata.
Chiavi	keys	keys
Ultimo visto	lastSeen	date	Data dell'ultima vista.
Conteggio agenti	agentCount	number	Conteggio agenti.

privateLocationsListSchema

Nome	Percorso	Tipo	Descrizione
Elementi		privatelocationschema

commonPrivateLocationSchemaResponse

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	guid	Identificatore.
Nome	name	string	Nome assegnato alla posizione privata.
Nome slug	slugName	string	Nome di slug valido.
Icona	icon	string	Icona della posizione privata.
Creato all'indirizzo	created_at	date	Al momento della creazione.
Aggiornato all'indirizzo	updated_at	date	Quando viene aggiornato all'indirizzo.
Controllare le assegnazioni	checkAssignments	checkAssignments	Verifica che questa posizione privata sia stata assegnata.
Assegnazioni di gruppo	groupAssignments	groupAssignments	Il gruppo a cui è stata assegnata la posizione privata.
Chiavi	keys	keys

Timestamp

Nome	Percorso	Tipo	Descrizione
Marca temporale:		date-time	Timestamp.

queueSize

Dimensioni della coda.

Nome	Percorso	Tipo	Descrizione
Elementi		number

oldestScheduledCheckRun

Nome	Percorso	Tipo	Descrizione
Elementi		number

privateLocationsMetricsHistoryResponseSchema

Nome	Percorso	Tipo	Descrizione
Timestamp	timestamps	timestamps
Dimensioni coda	queueSize	queueSize	Dimensioni della coda.
oldestScheduledCheckRun	oldestScheduledCheckRun	oldestScheduledCheckRun

ReportingTagList

Controllare i tag.

Nome	Percorso	Tipo	Descrizione
Elementi		string

Creazione di reportAggregate

Nome	Percorso	Tipo	Descrizione
Percentuale di esito positivo	successRatio	number	Percentuale di esito positivo del controllo rispetto all'intervallo di date selezionato. La percentuale è in formato decimale.
Medio	avg	number	Tempo medio di risposta del controllo sull'intervallo di date selezionato in millisecondi.
P95	p95	number	Tempo di risposta P95 del controllo sull'intervallo di date selezionato in millisecondi.
P99	p99	number	Tempo di risposta P99 del controllo sull'intervallo di date selezionato in millisecondi.

Rendicontazione

Nome	Percorso	Tipo	Descrizione
Nome	name	string	Controllare il nome.
Controllare l'ID	checkId	string	Controllare l'ID.
Check Type	checkType	string	Tipo di controllo.
Disattivato	deactivated	boolean	Selezionare disattivato.
Elenco di tag per la creazione di report	tags	ReportingTagList	Controllare i tag.
aggregate	aggregate	ReportingAggregate

ReportingList

Nome	Percorso	Tipo	Descrizione
Elementi		Reporting

Runtime

Nome	Percorso	Tipo	Descrizione
Nome	name	string	Nome univoco di questo runtime.
Fase	stage	string	Fase di vita corrente di un runtime.
Fine del ciclo di vita del runtime	runtimeEndOfLife	string	Data di rimozione di un runtime dalla piattaforma.
Default	default	boolean	Indica se si tratta del runtime predefinito corrente fornito da Checkly.
Description	description	string	Breve descrizione leggibile degli aggiornamenti principali in questo runtime.
String	dependencies.string	string	Stringa.

RuntimeList

Nome	Percorso	Tipo	Descrizione
Elementi		Runtime

Frammento

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	number	Identificatore.
Nome	name	string	Nome del frammento di codice.
Sceneggiatura	script	string	Il codice Node.js che interagisce con il ciclo di vita del controllo API o funziona come parziale per i controlli del browser.
Creato all'indirizzo	created_at	date-time	Al momento della creazione.
Aggiornato all'indirizzo	updated_at	date-time	Quando viene aggiornato all'indirizzo.

SnippetList

Nome	Percorso	Tipo	Descrizione
Elementi		Snippet

CheckGroupTrigger

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	number	Identificatore.
Token di accesso	token	string	Token.
Creato all'indirizzo	created_at	date	Al momento della creazione.
Chiamato all'indirizzo	called_at	date	Quando viene chiamato in .
Aggiornato all'indirizzo	updated_at	date	Quando viene aggiornato all'indirizzo.
ID del Gruppo	groupId	number	Identificatore del gruppo.

CheckTrigger

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	number	Identificatore.
Token di accesso	token	string	Token.
Creato all'indirizzo	created_at	date	Al momento della creazione.
Chiamato all'indirizzo	called_at	date	Quando viene chiamato in .
Aggiornato all'indirizzo	updated_at	date	Quando viene aggiornato all'indirizzo.
Controllare l'ID	checkId	string	Identificatore di controllo.

oggetto

Si tratta del tipo 'object'.

corda

Si tratta del tipo di dati di base 'string'.