Checkly (Éditeur indépendant) (préversion)
Checkly est la plateforme de surveillance pour la pile moderne : programmable, flexible et aimant JavaScript. Surveillez et validez vos transactions de site cruciales. Collectez automatiquement les traces d’erreurs, les captures d’écran et les métriques de performances avec chaque vérification que vous exécutez.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| Messagerie électronique | ttaylor@hitachisolutions.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Troy Taylor |
| Site internet | https://www.checklyhq.com/ |
| Politique de confidentialité | https://www.checklyhq.com/privacy |
| Catégories | Opérations informatiques |
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| ID de compte | securestring | ID de compte pour cette API. | Vrai |
| Clé API (sous la forme « Bearer apiKey ») | securestring | Clé API (sous la forme « Bearer apiKey ») pour cette API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Affiche les détails d’un runtime spécifique |
Affiche les détails de tous les packages NPM inclus et de leur version pour un runtime spécifique. |
| Création d’un tableau de bord |
Crée un tableau de bord. Retourne un 409 lors de la tentative de création d’un tableau de bord avec une URL personnalisée ou un domaine personnalisé déjà pris. |
| Créer le déclencheur de groupe de vérifications |
Crée le déclencheur de groupe de vérification. |
| Créer le déclencheur de vérification |
Crée le déclencheur de vérification. |
| Créer un canal d’alerte |
Crée un canal d’alerte. |
| Créer un emplacement privé |
Crée un emplacement privé. |
| Créer un extrait de code |
Crée un extrait de code. |
| Créer un groupe de vérifications |
Crée un groupe de vérifications. Vous pouvez ajouter des vérifications au groupe en définissant la propriété groupId des vérifications individuelles. |
| Créer une fenêtre de maintenance |
Crée une fenêtre de maintenance. |
| Créer une variable d’environnement |
Crée une variable d’environnement. |
| Créer une vérification [DÉCONSEILLÉE] |
[DÉCONSEILLÉ] Ce point de terminaison sera supprimé le lundi 4 juillet 2022. Utilisez plutôt |
| Créer une vérification du navigateur |
Crée une vérification du navigateur. Retourne une |
| Créer une vérification d’API |
Crée une vérification d’API. Retourne une |
| Génère un rapport avec des statistiques d’agrégation pour les vérifications et les groupes de vérification |
Génère un rapport avec des statistiques agrégées pour toutes les vérifications ou un ensemble filtré de vérifications sur une fenêtre de temps spécifiée. |
| Génère un rapport personnalisable pour toutes les métriques de vérification du navigateur |
Génère un rapport avec des statistiques agrégées ou non agrégées pour un contrôle de navigateur spécifique sur une fenêtre de temps spécifiée. |
| Générer une nouvelle clé API pour un emplacement privé |
Crée une clé API sur l’emplacement privé. |
| Mettre à jour les abonnements d’un canal d’alerte |
Mettez à jour les abonnements d’un canal d’alerte. Utilisez cette option pour ajouter une vérification à un canal d’alerte afin que les alertes de défaillance et de récupération soient envoyées pour cette vérification. Remarque : lors de la transmission de l’objet d’abonnement, vous ne pouvez spécifier qu’un checkId ou un groupId, et non les deux. |
| Mettre à jour un canal d’alerte |
Mettez à jour un canal d’alerte. |
| Mettre à jour un emplacement privé |
Met à jour un emplacement privé. |
| Mettre à jour un extrait de code |
Met à jour un extrait de code. |
| Mettre à jour un groupe de vérifications |
Met à jour un groupe de vérifications. |
| Mettre à jour un tableau de bord |
Met à jour un tableau de bord. Retourne un 409 lors de la tentative de création d’un tableau de bord avec une URL personnalisée ou un domaine personnalisé déjà pris. |
| Mettre à jour une fenêtre de maintenance |
Met à jour une fenêtre de maintenance. |
| Mettre à jour une variable d’environnement |
Met à jour une variable d’environnement. Utilise le champ clé comme identificateur pour la mise à jour. Met uniquement à jour la valeur et la propriété verrouillée. |
| Mettre à jour une vérification [DÉCONSEILLÉE] |
[DÉCONSEILLÉ] Ce point de terminaison sera supprimé le lundi 4 juillet 2022. Utilisez plutôt |
| Mettre à jour une vérification du navigateur |
Met à jour une vérification du navigateur. |
| Mettre à jour une vérification d’API |
Met à jour une vérification d’API. |
| Obtenir le badge d’état de vérification |
Obtenir le badge d’état de vérification. |
| Obtenir le badge d’état du groupe |
Obtenir le badge d’état du groupe. |
| Obtenir le déclencheur de groupe de vérification |
Recherche le déclencheur de groupe de vérification. |
| Obtenir le déclencheur de vérification |
Recherche le déclencheur de vérification. |
| Obtenir les métriques d’intégrité d’emplacement privé à partir d’une fenêtre de temps |
Obtenez des métriques d’intégrité d’emplacement privé à partir d’une fenêtre de temps. |
| Récupérer les détails de l’état de vérification |
Affichez les informations d’état actuelles pour une vérification spécifique. |
| Récupérer toutes les vérifications dans un groupe spécifique avec les paramètres de groupe appliqués |
Répertorie toutes les vérifications dans un groupe de vérifications spécifique avec les paramètres de groupe appliqués. |
| Récupérer un canal d’alerte |
Afficher les détails d’un canal d’alerte spécifique. |
| Récupérer un emplacement privé |
Afficher les détails d’un emplacement privé spécifique. |
| Récupérer un extrait de code |
Afficher les détails d’un extrait de code spécifique. |
| Récupérer un groupe de vérifications |
Afficher les détails d’un groupe de vérification spécifique. |
| Récupérer un résultat de vérification |
Afficher les détails d’un résultat de vérification spécifique. |
| Récupérer une fenêtre de maintenance |
Afficher les détails d’une fenêtre de maintenance spécifique. |
| Récupérer une variable d’environnement |
Afficher les détails d’une variable d’environnement spécifique. Utilise le champ clé pour la sélection. |
| Récupérer une vérification |
Afficher les détails d’une vérification spécifique de l’API ou du navigateur. |
| Récupérer une vérification dans un groupe spécifique avec les paramètres de groupe appliqués |
Affichez les détails d’une vérification dans un groupe de vérification spécifique avec les paramètres de groupe appliqués. |
| Répertorie tous les emplacements pris en charge |
Répertorie tous les emplacements pris en charge. |
| Répertorie tous les runtimes pris en charge |
Répertorie tous les runtimes pris en charge et les packages NPM inclus pour les vérifications du navigateur et l’installation des scripts de démontage pour les vérifications d’API. |
| Répertorie tous les résultats de la vérification |
Répertorie les résultats complets de la vérification brute pour une vérification spécifique. Nous conservons les résultats bruts pendant 30 jours. Après 30 jours, ils sont effacés. Toutefois, nous conservons les résultats enregistrés pendant une période indéfinie. Vous pouvez filtrer par type de vérification et type de résultat pour affiner la liste. Utilisez les paramètres et |
| Répertorier les alertes pour une vérification spécifique |
Répertorie toutes les alertes pour une vérification spécifique. |
| Répertorier tous les canaux d’alerte |
Répertorie tous les canaux d’alerte configurés et leurs vérifications abonnées. |
| Répertorier tous les emplacements privés |
Répertorie tous les emplacements privés de votre compte. |
| Répertorier tous les extraits de code |
Répertorie tous les extraits de code actuels dans votre compte. |
| Répertorier tous les groupes de vérifications |
Répertorie tous les groupes de vérification actuels dans votre compte. La propriété de vérification est un tableau de vérifications UUID pour référencer facilement. Il est en lecture seule et vous ne pouvez pas l’utiliser pour ajouter des vérifications à un groupe. |
| Répertorier tous les tableaux de bord |
Répertorie tous les tableaux de bord actuels dans votre compte. |
| Répertorier tous les états de vérification |
Affiche les informations d’état actuelles pour toutes les vérifications dans votre compte. Les enregistrements d’état de vérification sont mis à jour en permanence à mesure que les nouveaux résultats de vérification sont ajoutés. |
| Répertorier toutes les alertes pour votre compte |
Répertorie toutes les alertes de votre compte. |
| Répertorier toutes les fenêtres de maintenance |
Répertorie toutes les fenêtres de maintenance de votre compte. |
| Répertorier toutes les variables d’environnement |
Répertorie toutes les variables d’environnement actuelles dans votre compte. |
| Répertorier toutes les vérifications |
Répertorie toutes les vérifications actuelles dans votre compte. |
| Supprimer le déclencheur de groupe de vérification |
Supprime le déclencheur de groupes de vérifications. |
| Supprimer le déclencheur de vérification |
Supprime le déclencheur de vérification. |
| Supprimer un canal d’alerte |
Supprime définitivement un canal d’alerte. |
| Supprimer un emplacement privé |
Supprime définitivement un emplacement privé. |
| Supprimer un extrait de code |
Supprime définitivement un extrait de code. |
| Supprimer un groupe de vérifications |
Supprime définitivement un groupe de vérifications. Vous ne pouvez pas supprimer un groupe de vérifications s’il contient toujours des vérifications. |
| Supprimer un tableau de bord |
Supprime définitivement un tableau de bord. |
| Supprimer une clé API existante pour un emplacement privé |
Supprime définitivement une clé API d’un emplacement privé. |
| Supprimer une fenêtre de maintenance |
Supprime définitivement une fenêtre de maintenance. |
| Supprimer une variable d’environnement |
Supprime définitivement une variable d’environnement. Utilise le champ de clé comme identificateur pour la suppression. |
| Supprimer une vérification |
Supprime définitivement une vérification d’API ou de navigateur et toutes ses données d’état et de résultats associées. |
Affiche les détails d’un runtime spécifique
Affiche les détails de tous les packages NPM inclus et de leur version pour un runtime spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
Identificateur. |
Retours
- Corps
- Runtime
Création d’un tableau de bord
Crée un tableau de bord. Retourne un 409 lors de la tentative de création d’un tableau de bord avec une URL personnalisée ou un domaine personnalisé déjà pris.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
URL personnalisée
|
customUrl | string |
Nom de sous-domaine sous checklyhq.com. Doit être unique pour tous les utilisateurs. |
|
|
Domaine personnalisé
|
customDomain | string |
Un domaine d’utilisateur personnalisé, par exemple, status.example.com. Consultez les documents sur la mise à jour de votre utilisation DNS et SSL. |
|
|
Logo
|
logo | string |
URL pointant vers un fichier image. |
|
|
Favicon
|
favicon | string |
URL pointant vers un fichier image utilisé comme favicon de tableau de bord. |
|
|
Lien
|
link | string |
Lien d’URL à rediriger lorsque le logo du tableau de bord est cliqué dessus. |
|
|
Header
|
header | string |
Élément de texte affiché en haut de votre tableau de bord. |
|
|
Descriptif
|
description | string |
Élément de texte affiché sous l’en-tête ou le titre de votre tableau de bord. |
|
|
Largeur
|
width | string |
Détermine s’il faut utiliser l’écran plein ou le focus dans le centre. |
|
|
Taux d’actualisation
|
refreshRate | number |
Fréquence d’actualisation du tableau de bord en secondes. |
|
|
Paginer
|
paginate | boolean |
Détermine la pagination est activée ou désactivée. |
|
|
Taux de pagination
|
paginationRate | number |
Fréquence à laquelle déclencher la pagination en secondes. |
|
|
Vérifications par page
|
checksPerPage | number |
Nombre de vérifications affichées par page. |
|
|
Utiliser et opérateur
|
useTagsAndOperator | boolean |
Quand utiliser l’opérateur AND pour la recherche de balises. |
|
|
Masquer les étiquettes
|
hideTags | boolean |
Affichez ou masquez les balises dans le tableau de bord. |
|
|
Liste des balises du tableau de bord
|
tags | array of string |
Liste d’une ou de plusieurs balises qui filtrent les contrôles à afficher sur le tableau de bord. |
Retours
- Corps
- Dashboard
Créer le déclencheur de groupe de vérifications
Crée le déclencheur de groupe de vérification.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de groupe
|
groupId | True | integer |
Identificateur de groupe. |
Retours
- Corps
- CheckGroupTrigger
Créer le déclencheur de vérification
Crée le déclencheur de vérification.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Vérifier l’ID
|
checkId | True | string |
Identificateur de vérification. |
Retours
- Corps
- CheckTrigger
Créer un canal d’alerte
Crée un canal d’alerte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | number |
Identificateur. |
|
|
Vérifier l’ID
|
checkId | guid |
Identificateur de vérification. |
|
|
ID de groupe
|
groupId | number |
Identificateur de groupe. |
|
|
Activated
|
activated | True | boolean |
Indique s’il est activé. |
|
Type
|
type | True | string |
Type. |
|
Configuration de création d’un canal d’alerte
|
config | True | object |
Le canal d’alerte crée la configuration. |
|
Envoyer la récupération
|
sendRecovery | boolean |
Indique si la récupération est envoyée. |
|
|
Échec d’envoi
|
sendFailure | boolean |
Indique si l’envoi échoue. |
|
|
Envoyer détérioré
|
sendDegraded | boolean |
Indique si l’envoi est détérioré. |
|
|
Expiration SSL
|
sslExpiry | boolean |
Détermine si une alerte doit être envoyée pour l’expiration des certificats SSL. |
|
|
Seuil d’expiration SSL
|
sslExpiryThreshold | integer |
À quel moment dans le temps commencer à alerter sur les certificats SSL. |
Retours
- Corps
- AlertChannel
Créer un emplacement privé
Crée un emplacement privé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom
|
name | True | string |
Nom attribué à l’emplacement privé. |
|
Nom slug
|
slugName | True | string |
Nom de la slug valide. |
|
Icône
|
icon | string |
Icône. |
Retours
Créer un extrait de code
Crée un extrait de code.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom
|
name | True | string |
Nom de l’extrait de code. |
|
Scénario
|
script | True | string |
Votre code Node.js qui interagit avec le cycle de vie de vérification de l’API ou fonctionne comme un élément partiel pour les vérifications de navigateur. |
Retours
- Corps
- Snippet
Créer un groupe de vérifications
Crée un groupe de vérifications. Vous pouvez ajouter des vérifications au groupe en définissant la propriété groupId des vérifications individuelles.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Attribuer automatiquement des alertes
|
autoAssignAlerts | boolean |
Détermine si une nouvelle vérification est automatiquement ajoutée en tant qu’abonné à tous les canaux d’alerte existants lors de sa création. |
|
|
Nom
|
name | True | string |
Nom du groupe de vérifications. |
|
Activated
|
activated | boolean |
Détermine si les vérifications dans le groupe sont en cours d’exécution ou non. |
|
|
Assourdi
|
muted | boolean |
Détermine si des notifications sont envoyées lorsqu’un enregistrement dans ce groupe échoue et/ou récupère. |
|
|
Vérifier la liste des étiquettes de groupe
|
tags | array of string |
Balises pour l’organisation et le filtrage des vérifications. |
|
|
Vérifier la liste d’emplacements du groupe
|
locations | array of string |
Tableau d’un ou plusieurs emplacements de centre de données où exécuter les vérifications. |
|
|
Concurrency
|
concurrency | number |
Détermine le nombre de vérifications appelées simultanément lors du déclenchement d’un groupe de vérifications à partir de CI/CD ou via l’API. |
|
|
URL
|
url | string |
URL de base de ce groupe que vous pouvez référencer avec la variable {{GROUP_BASE_URL}} dans toutes les vérifications de groupe. |
|
|
Key
|
key | True | string |
La clé. |
|
Valeur
|
value | True | string |
Valeur. |
|
Verrouillé
|
locked | boolean |
Indique s’il est verrouillé. |
|
|
Origine
|
source | string |
Source. |
|
|
Propriété
|
property | string |
Propriété. |
|
|
Comparison
|
comparison | string |
Comparaison. |
|
|
Cible
|
target | string |
Cible. |
|
|
Nom d’utilisateur
|
username | True | string |
Nom d’utilisateur. |
|
Mot de passe
|
password | True | string |
Mot de passe. |
|
Vérifier les valeurs par défaut de vérification du navigateur de création de groupe
|
browserCheckDefaults | object |
Le groupe de vérifications crée les valeurs par défaut de vérification du navigateur. |
|
|
ID d’exécution
|
runtimeId | string |
Version du runtime, c’est-à-dire ensemble fixe de dépendances d’exécution, utilisée pour exécuter des vérifications dans ce groupe. |
|
|
Key
|
key | True | string |
Clé de la variable d’environnement (cette valeur ne peut pas être modifiée). |
|
Valeur
|
value | True | string |
Valeur de la variable d’environnement. |
|
Verrouillé
|
locked | boolean |
Utilisé uniquement dans l’interface utilisateur pour masquer la valeur comme un mot de passe. |
|
|
Vérification double
|
doubleCheck | boolean |
La définition de cette valeur sur true déclenche une nouvelle tentative lorsqu’une vérification échoue à partir de la région défaillante et une autre région sélectionnée de manière aléatoire avant d’marquer la vérification comme ayant échoué. |
|
|
Utiliser les paramètres d’alerte globale
|
useGlobalAlertSettings | boolean |
Lorsque la valeur est true, le paramètre d’alerte au niveau du compte est utilisé, et non le paramètre d’alerte défini sur ce groupe de vérifications. |
|
|
Type d’escalade
|
escalationType | string |
Détermine le type d’escalade à utiliser. |
|
|
Seuil d’exécution ayant échoué
|
failedRunThreshold | number |
Après l’échec de la vérification consécutive, une notification d’alerte doit être envoyée. |
|
|
Seuil d’échec des minutes
|
minutesFailingThreshold | number |
Après le nombre de minutes après l’échec d’une vérification, une alerte doit être envoyée. |
|
|
Montant
|
amount | number |
Nombre de rappels à envoyer après la notification d’alerte initiale. |
|
|
Intervalle
|
interval | number |
À quel intervalle les rappels doivent être envoyés. |
|
|
Enabled
|
enabled | boolean |
Détermine si les notifications d’alerte doivent être envoyées pour l’expiration des certificats SSL. |
|
|
Seuil d’alerte
|
alertThreshold | integer |
À quel moment dans le temps commencer à alerter sur les certificats SSL. |
|
|
ID du canal d’alerte
|
alertChannelId | True | number |
Identificateur du canal d’alerte. |
|
Activated
|
activated | True | boolean |
Indique s’il est activé. |
|
ID d’extrait de code d’installation
|
setupSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase d’installation d’une vérification d’API dans ce groupe. |
|
|
ID de l’extrait de code de destruction
|
tearDownSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase de destruction d’une vérification d’API dans ce groupe. |
|
|
Script d’installation local
|
localSetupScript | string |
Élément valide de Node.js code à exécuter dans la phase d’installation d’une vérification d’API dans ce groupe. |
|
|
Script de destruction locale
|
localTearDownScript | string |
Élément de Node.js code valide à exécuter dans la phase de déblochage d’une vérification d’API dans ce groupe. |
|
|
Vérifier les emplacements privés
|
privateLocations | array of string |
Tableau d’un ou plusieurs emplacements privés où exécuter les vérifications. |
Retours
- Corps
- CheckGroup
Créer une fenêtre de maintenance
Crée une fenêtre de maintenance.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom
|
name | True | string |
Nom de la fenêtre de maintenance. |
|
Liste des balises de fenêtre de maintenance
|
tags | array of string |
Les noms de la fenêtre de maintenance des contrôles et des groupes doivent s’appliquer. |
|
|
Commence à
|
startsAt | True | date |
Date de début de la fenêtre de maintenance. |
|
Se termine à
|
endsAt | True | date |
Date de fin de la fenêtre de maintenance. |
|
Intervalle de répétition
|
repeatInterval | number |
Intervalle de répétition de la fenêtre de maintenance à partir de la première occurrence. |
|
|
Unité de répétition
|
repeatUnit | True | string |
Stratégie de répétition de la fenêtre de maintenance. |
|
Répéter les extrémités à
|
repeatEndsAt | date |
Date de fin où la fenêtre de maintenance doit cesser de se répéter. |
Retours
- Corps
- MaintenanceWindow
Créer une variable d’environnement
Crée une variable d’environnement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Key
|
key | True | string |
Clé de la variable d’environnement (cette valeur ne peut pas être modifiée). |
|
Valeur
|
value | True | string |
Valeur de la variable d’environnement. |
|
Verrouillé
|
locked | boolean |
Utilisé uniquement dans l’interface utilisateur pour masquer la valeur comme un mot de passe. |
Retours
- Corps
- EnvironmentVariable
Créer une vérification [DÉCONSEILLÉE]
[DÉCONSEILLÉ] Ce point de terminaison sera supprimé le lundi 4 juillet 2022. Utilisez plutôt POST /checks/api ou POST /checks/browser. Crée une vérification d’API ou de navigateur. Retourne une 402 fois que vous dépassez la limite de votre plan. Lors de l’utilisation de l’objet , il peut s’agir globalAlertSettingsalertSettingsnull
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Attribuer automatiquement des alertes
|
autoAssignAlerts | boolean |
Détermine si une nouvelle vérification est automatiquement ajoutée en tant qu’abonné à tous les canaux d’alerte existants lors de sa création. |
|
|
Nom
|
name | True | string |
Nom de la vérification. |
|
Activated
|
activated | True | boolean |
Détermine si la vérification est en cours d’exécution ou non. |
|
Assourdi
|
muted | boolean |
Détermine si des notifications sont envoyées lorsqu’une vérification échoue et/ou récupère. |
|
|
Vérification double
|
doubleCheck | boolean |
La définition de cette valeur sur true déclenche une nouvelle tentative lorsqu’une vérification échoue à partir de la région défaillante et une autre région sélectionnée de manière aléatoire avant d’marquer la vérification comme ayant échoué. |
|
|
Doit échouer
|
shouldFail | boolean |
Permet d’inverser le comportement de l’échec d’une vérification. Permet de valider l’état d’erreur comme 404. |
|
|
Vérifier la liste des emplacements
|
locations | array of string |
Tableau d’un ou plusieurs emplacements de centre de données où exécuter cette vérification. |
|
|
Vérifier la liste des balises
|
tags | array of string |
Balises pour l’organisation et le filtrage des vérifications. |
|
|
Type d’escalade
|
escalationType | string |
Détermine le type d’escalade à utiliser. |
|
|
Seuil d’exécution ayant échoué
|
failedRunThreshold | number |
Après l’échec de la vérification consécutive, une notification d’alerte doit être envoyée. |
|
|
Seuil d’échec des minutes
|
minutesFailingThreshold | number |
Après le nombre de minutes après l’échec d’une vérification, une alerte doit être envoyée. |
|
|
Montant
|
amount | number |
Nombre de rappels à envoyer après la notification d’alerte initiale. |
|
|
Intervalle
|
interval | number |
À quel intervalle les rappels doivent être envoyés. |
|
|
Enabled
|
enabled | boolean |
Détermine si les notifications d’alerte doivent être envoyées pour l’expiration des certificats SSL. |
|
|
Seuil d’alerte
|
alertThreshold | integer |
À quel moment dans le temps commencer à alerter sur les certificats SSL. |
|
|
Utiliser les paramètres d’alerte globale
|
useGlobalAlertSettings | boolean |
Lorsque la valeur est true, le paramètre d’alerte au niveau du compte est utilisé, et non le paramètre d’alerte défini sur cette vérification. |
|
|
ID de groupe
|
groupId | number |
L’identificateur du groupe de vérifications dont fait partie cette vérification. |
|
|
Ordre de groupe
|
groupOrder | number |
Position de cette vérification dans un groupe de vérifications. Il détermine dans quel ordre les vérifications sont exécutées lorsqu’un groupe est déclenché à partir de l’API ou de CI/CD. |
|
|
ID d’exécution
|
runtimeId | string |
La version du runtime, c’est-à-dire l’ensemble fixe de dépendances d’exécution, utilisé pour exécuter cette vérification. |
|
|
ID du canal d’alerte
|
alertChannelId | True | number |
Identificateur du canal d’alerte. |
|
Activated
|
activated | True | boolean |
Indique s’il est activé. |
|
Vérifier le type
|
checkType | True | string |
Type de la vérification. |
|
Fréquence
|
frequency | integer |
Fréquence à laquelle la vérification doit s’exécuter en minutes. |
|
|
Décalage de fréquence
|
frequencyOffset | integer |
Utilisé pour définir des secondes pour les fréquences de vérification de moins de 1 minutes (uniquement pour les vérifications d’API) et la répartition des vérifications sur une plage de temps pour les fréquences de plus de 1 minute. Cela fonctionne comme suit : Les vérifications avec une fréquence de 0 peuvent avoir une fréquenceOffset de 10, 20 ou 30, ce qui signifie qu’elles s’exécutent toutes les 10, 20 ou 30 secondes. Les vérifications avec une fréquence inférieure et égale à 60 peuvent avoir une fréquenceOffset comprise entre 1 et une valeur maximale basée sur la formule Math.floor(frequency * 10), c’est-à-dire pour une vérification qui s’exécute toutes les 5 minutes, la fréquence maximaleOffset est de 50. Les vérifications avec une fréquence supérieure à 60 peuvent avoir un frequencyOffset compris entre 1 et une valeur maximale basée sur la formule Math.ceil(frequency / 60), c’est-à-dire pour une vérification qui s’exécute toutes les 720 minutes, la fréquence maximaleOffset est 12. |
|
|
Vérifier la demande
|
request | object |
Demande de vérification. |
|
|
Scénario
|
script | True | string |
Script. |
|
Key
|
key | True | string |
Clé de la variable d’environnement (cette valeur ne peut pas être modifiée). |
|
Valeur
|
value | True | string |
Valeur de la variable d’environnement. |
|
Verrouillé
|
locked | boolean |
Utilisé uniquement dans l’interface utilisateur pour masquer la valeur comme un mot de passe. |
|
|
ID d’extrait de code d’installation
|
setupSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase d’installation d’une vérification d’API. |
|
|
ID de l’extrait de code de destruction
|
tearDownSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase de destruction d’une vérification d’API. |
|
|
Script d’installation local
|
localSetupScript | string |
Élément valide de Node.js code à exécuter dans la phase d’installation. |
|
|
Script de destruction locale
|
localTearDownScript | string |
Élément valide de Node.js code à exécuter dans la phase de déblochage. |
|
|
Temps de réponse détérioré
|
degradedResponseTime | number |
Temps de réponse en millisecondes où une vérification doit être considérée comme détériorée. |
|
|
Temps de réponse maximal
|
maxResponseTime | number |
Temps de réponse en millisecondes où une vérification doit être considérée comme défaillante. |
|
|
Emplacements privés
|
privateLocations | array of string |
Tableau d’un ou plusieurs emplacements privés où exécuter la vérification. |
Retours
- Corps
- Check
Créer une vérification du navigateur
Crée une vérification du navigateur. Retourne une 402 fois que vous dépassez la limite de votre plan. Lors de l’utilisation de l’objet , il peut s’agir globalAlertSettingalertSettingnull
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Attribuer automatiquement des alertes
|
autoAssignAlerts | boolean |
Détermine si une nouvelle vérification est automatiquement ajoutée en tant qu’abonné à tous les canaux d’alerte existants lors de sa création. |
|
|
Nom
|
name | True | string |
Nom de la vérification. |
|
Activated
|
activated | True | boolean |
Détermine si la vérification est en cours d’exécution ou non. |
|
Assourdi
|
muted | boolean |
Détermine si des notifications sont envoyées lorsqu’une vérification échoue et/ou récupère. |
|
|
Vérification double
|
doubleCheck | boolean |
La définition de cette valeur sur true déclenche une nouvelle tentative lorsqu’une vérification échoue à partir de la région défaillante et une autre région sélectionnée de manière aléatoire avant d’marquer la vérification comme ayant échoué. |
|
|
Doit échouer
|
shouldFail | boolean |
Permet d’inverser le comportement de l’échec d’une vérification. Permet de valider l’état d’erreur comme 404. |
|
|
Vérifier la liste des emplacements
|
locations | array of string |
Tableau d’un ou plusieurs emplacements de centre de données où exécuter cette vérification. |
|
|
Vérifier la liste des balises
|
tags | array of string |
Balises pour l’organisation et le filtrage des vérifications. |
|
|
Type d’escalade
|
escalationType | string |
Détermine le type d’escalade à utiliser. |
|
|
Seuil d’exécution ayant échoué
|
failedRunThreshold | number |
Après l’échec de la vérification consécutive, une notification d’alerte doit être envoyée. |
|
|
Seuil d’échec des minutes
|
minutesFailingThreshold | number |
Après le nombre de minutes après l’échec d’une vérification, une alerte doit être envoyée. |
|
|
Montant
|
amount | number |
Nombre de rappels à envoyer après la notification d’alerte initiale. |
|
|
Intervalle
|
interval | number |
À quel intervalle les rappels doivent être envoyés. |
|
|
Enabled
|
enabled | boolean |
Détermine si les notifications d’alerte doivent être envoyées pour l’expiration des certificats SSL. |
|
|
Seuil d’alerte
|
alertThreshold | integer |
À quel moment dans le temps commencer à alerter sur les certificats SSL. |
|
|
Utiliser les paramètres d’alerte globale
|
useGlobalAlertSettings | boolean |
Lorsque la valeur est true, le paramètre d’alerte au niveau du compte est utilisé, et non le paramètre d’alerte défini sur cette vérification. |
|
|
ID de groupe
|
groupId | number |
L’identificateur du groupe de vérifications dont fait partie cette vérification. |
|
|
Ordre de groupe
|
groupOrder | number |
Position de cette vérification dans un groupe de vérifications. Il détermine dans quel ordre les vérifications sont exécutées lorsqu’un groupe est déclenché à partir de l’API ou de CI/CD. |
|
|
ID d’exécution
|
runtimeId | string |
La version du runtime, c’est-à-dire l’ensemble fixe de dépendances d’exécution, utilisé pour exécuter cette vérification. |
|
|
ID du canal d’alerte
|
alertChannelId | True | number |
Identificateur du canal d’alerte. |
|
Activated
|
activated | True | boolean |
Indique s’il est activé. |
|
Key
|
key | True | string |
Clé de la variable d’environnement (cette valeur ne peut pas être modifiée). |
|
Valeur
|
value | True | string |
Valeur de la variable d’environnement. |
|
Verrouillé
|
locked | boolean |
Utilisé uniquement dans l’interface utilisateur pour masquer la valeur comme un mot de passe. |
|
|
Fréquence
|
frequency | integer |
Fréquence à laquelle la vérification doit s’exécuter en minutes. |
|
|
Scénario
|
script | True | string |
Élément valide de Node.js code javascript décrivant une interaction de navigateur avec les frameworks Puppeteer ou Playwright. |
|
Emplacements privés
|
privateLocations | array of string |
Tableau d’un ou plusieurs emplacements privés où exécuter la vérification. |
Retours
- Corps
- CheckBrowser
Créer une vérification d’API
Crée une vérification d’API. Retourne une 402 fois que vous dépassez la limite de votre plan. Lors de l’utilisation de l’objet , il peut s’agir globalAlertSettingalertSettingnull
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Attribuer automatiquement des alertes
|
autoAssignAlerts | boolean |
Détermine si une nouvelle vérification est automatiquement ajoutée en tant qu’abonné à tous les canaux d’alerte existants lors de sa création. |
|
|
Nom
|
name | True | string |
Nom de la vérification. |
|
Activated
|
activated | True | boolean |
Détermine si la vérification est en cours d’exécution ou non. |
|
Assourdi
|
muted | boolean |
Détermine si des notifications sont envoyées lorsqu’une vérification échoue et/ou récupère. |
|
|
Vérification double
|
doubleCheck | boolean |
La définition de cette valeur sur true déclenche une nouvelle tentative lorsqu’une vérification échoue à partir de la région défaillante et une autre région sélectionnée de manière aléatoire avant d’marquer la vérification comme ayant échoué. |
|
|
Doit échouer
|
shouldFail | boolean |
Permet d’inverser le comportement de l’échec d’une vérification. Permet de valider l’état d’erreur comme 404. |
|
|
Vérifier la liste des emplacements
|
locations | array of string |
Tableau d’un ou plusieurs emplacements de centre de données où exécuter cette vérification. |
|
|
Vérifier la liste des balises
|
tags | array of string |
Balises pour l’organisation et le filtrage des vérifications. |
|
|
Type d’escalade
|
escalationType | string |
Détermine le type d’escalade à utiliser. |
|
|
Seuil d’exécution ayant échoué
|
failedRunThreshold | number |
Après l’échec de la vérification consécutive, une notification d’alerte doit être envoyée. |
|
|
Seuil d’échec des minutes
|
minutesFailingThreshold | number |
Après le nombre de minutes après l’échec d’une vérification, une alerte doit être envoyée. |
|
|
Montant
|
amount | number |
Nombre de rappels à envoyer après la notification d’alerte initiale. |
|
|
Intervalle
|
interval | number |
À quel intervalle les rappels doivent être envoyés. |
|
|
Enabled
|
enabled | boolean |
Détermine si les notifications d’alerte doivent être envoyées pour l’expiration des certificats SSL. |
|
|
Seuil d’alerte
|
alertThreshold | integer |
À quel moment dans le temps commencer à alerter sur les certificats SSL. |
|
|
Utiliser les paramètres d’alerte globale
|
useGlobalAlertSettings | boolean |
Lorsque la valeur est true, le paramètre d’alerte au niveau du compte est utilisé, et non le paramètre d’alerte défini sur cette vérification. |
|
|
ID de groupe
|
groupId | number |
L’identificateur du groupe de vérifications dont fait partie cette vérification. |
|
|
Ordre de groupe
|
groupOrder | number |
Position de cette vérification dans un groupe de vérifications. Il détermine dans quel ordre les vérifications sont exécutées lorsqu’un groupe est déclenché à partir de l’API ou de CI/CD. |
|
|
ID d’exécution
|
runtimeId | string |
La version du runtime, c’est-à-dire l’ensemble fixe de dépendances d’exécution, utilisé pour exécuter cette vérification. |
|
|
ID du canal d’alerte
|
alertChannelId | True | number |
Identificateur du canal d’alerte. |
|
Activated
|
activated | True | boolean |
Indique s’il est activé. |
|
method
|
method | True | string | |
|
URL
|
url | True | string |
Adresse URL. |
|
Suivre les redirections
|
followRedirects | boolean |
Indique si suit les redirections. |
|
|
Ignorer SSL
|
skipSSL | boolean |
Indique s’il faut ignorer SSL. |
|
|
Corps
|
body | string |
Le corps. |
|
|
bodyType
|
bodyType | string | ||
|
Key
|
key | True | string |
La clé. |
|
Valeur
|
value | True | string |
Valeur. |
|
Verrouillé
|
locked | boolean |
Indique s’il est verrouillé. |
|
|
Origine
|
source | string |
Source. |
|
|
Propriété
|
property | string |
Propriété. |
|
|
Comparison
|
comparison | string |
Comparaison. |
|
|
Cible
|
target | string |
Cible. |
|
|
Nom d’utilisateur
|
username | True | string |
Nom d’utilisateur. |
|
Mot de passe
|
password | True | string |
Mot de passe. |
|
Fréquence
|
frequency | integer |
Fréquence à laquelle la vérification doit s’exécuter en minutes. |
|
|
ID de l’extrait de code de destruction
|
tearDownSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase de destruction d’une vérification d’API. |
|
|
ID d’extrait de code d’installation
|
setupSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase d’installation d’une vérification d’API. |
|
|
Décalage de fréquence
|
frequencyOffset | integer |
Utilisé pour définir des secondes pour les fréquences de vérification de moins de 1 minutes et la répartition des vérifications sur une plage de temps pour les fréquences supérieures à 1 minute. Cela fonctionne comme suit : Les vérifications avec une fréquence de 0 peuvent avoir une fréquenceOffset de 10, 20 ou 30, ce qui signifie qu’elles s’exécutent toutes les 10, 20 ou 30 secondes. Les vérifications avec une fréquence inférieure et égale à 60 peuvent avoir une fréquenceOffset comprise entre 1 et une valeur maximale basée sur la formule Math.floor(frequency * 10), c’est-à-dire pour une vérification qui s’exécute toutes les 5 minutes, la fréquence maximaleOffset est de 50. Les vérifications avec une fréquence supérieure à 60 peuvent avoir un frequencyOffset compris entre 1 et une valeur maximale basée sur la formule Math.ceil(frequency / 60), c’est-à-dire pour une vérification qui s’exécute toutes les 720 minutes, la fréquence maximaleOffset est 12. |
|
|
Script d’installation local
|
localSetupScript | string |
Élément valide de Node.js code à exécuter dans la phase d’installation. |
|
|
Script de destruction locale
|
localTearDownScript | string |
Élément valide de Node.js code à exécuter dans la phase de déblochage. |
|
|
Temps de réponse détérioré
|
degradedResponseTime | number |
Temps de réponse en millisecondes où une vérification doit être considérée comme détériorée. |
|
|
Temps de réponse maximal
|
maxResponseTime | number |
Temps de réponse en millisecondes où une vérification doit être considérée comme défaillante. |
|
|
Emplacements privés
|
privateLocations | array of string |
Tableau d’un ou plusieurs emplacements privés où exécuter la vérification. |
Retours
- Corps
- CheckAPI
Génère un rapport avec des statistiques d’agrégation pour les vérifications et les groupes de vérification
Génère un rapport avec des statistiques agrégées pour toutes les vérifications ou un ensemble filtré de vérifications sur une fenêtre de temps spécifiée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
De
|
from | date |
Heure de début personnalisée de la fenêtre de création de rapports au format timestamp unix. La définition d’un horodatage personnalisé remplace l’utilisation de n’importe quel préréglageWindow. |
|
|
À
|
to | date |
Heure de fin personnalisée de la fenêtre de création de rapports au format timestamp unix. La définition d’un horodatage personnalisé remplace l’utilisation de n’importe quel préréglageWindow. |
|
|
Fenêtre prédéfinie
|
presetWindow | string |
Les fenêtres de création de rapports prédéfinies sont utilisées pour générer rapidement un rapport sur des fenêtres couramment utilisées. Peut être substitué à l’aide d’un horodatage personnalisé vers et depuis l’horodatage. |
|
|
Filtrer par étiquettes
|
filterByTags | array |
Utilisez des balises pour filtrer les vérifications que vous souhaitez voir dans votre rapport. |
|
|
Désactivé
|
deactivated | boolean |
Filtrez les vérifications par état activé. |
Retours
- Objets
- ReportingList
Génère un rapport personnalisable pour toutes les métriques de vérification du navigateur
Génère un rapport avec des statistiques agrégées ou non agrégées pour un contrôle de navigateur spécifique sur une fenêtre de temps spécifiée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
Identificateur. |
|
De
|
from | date |
Heure de début personnalisée de la fenêtre de création de rapports au format timestamp unix. La définition d’un horodatage personnalisé remplace l’utilisation de n’importe quel préréglageWindow. |
|
|
À
|
to | date |
Heure de fin personnalisée de la fenêtre de création de rapports au format timestamp unix. La définition d’un horodatage personnalisé remplace l’utilisation de n’importe quel préréglageWindow. |
|
|
Fenêtre prédéfinie
|
presetWindow | string |
Les fenêtres de création de rapports prédéfinies sont utilisées pour générer rapidement un rapport sur des fenêtres couramment utilisées. Peut être substitué à l’aide d’un horodatage personnalisé vers et depuis l’horodatage. |
|
|
Intervalle d’agrégation
|
aggregationInterval | number |
Intervalle de temps à utiliser pour l’agrégation des métriques en minutes. Par exemple, cinq minutes sont 300, 24 heures sont 1440. |
|
|
Regrouper par
|
groupBy | string |
Détermine la façon dont les données de série sont regroupées. |
|
|
Filtrer par état
|
filterByStatus | array |
Utilisez l’état pour filtrer les données de résultat de vérification ayant échoué ou réussies. |
|
|
Metrics
|
metrics | array |
Options de métriques pour les vérifications de navigateur. |
Retours
Attributs.
- Attributes
- object
Générer une nouvelle clé API pour un emplacement privé
Crée une clé API sur l’emplacement privé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
Identificateur. |
Retours
- Corps
- privateLocationKeys
Mettre à jour les abonnements d’un canal d’alerte
Mettez à jour les abonnements d’un canal d’alerte. Utilisez cette option pour ajouter une vérification à un canal d’alerte afin que les alertes de défaillance et de récupération soient envoyées pour cette vérification. Remarque : lors de la transmission de l’objet d’abonnement, vous ne pouvez spécifier qu’un checkId ou un groupId, et non les deux.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
Identificateur. |
|
Vérifier l’ID
|
checkId | guid |
Vous pouvez passer un checkId ou un groupId, mais pas les deux. |
|
|
ID de groupe
|
groupId | number |
Vous pouvez passer un checkId ou un groupId, mais pas les deux. |
|
|
Activated
|
activated | True | boolean |
Indique s’il est activé. |
Retours
- Corps
- AlertChanelSubscription
Mettre à jour un canal d’alerte
Mettez à jour un canal d’alerte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
Identificateur. |
|
ID
|
id | number |
Identificateur. |
|
|
Vérifier l’ID
|
checkId | guid |
Identificateur de vérification. |
|
|
ID de groupe
|
groupId | number |
Identificateur de groupe. |
|
|
Activated
|
activated | True | boolean |
Indique s’il est activé. |
|
Type
|
type | True | string |
Type. |
|
Configuration de création d’un canal d’alerte
|
config | True | object |
Le canal d’alerte crée la configuration. |
|
Envoyer la récupération
|
sendRecovery | boolean |
Indique si la récupération est envoyée. |
|
|
Échec d’envoi
|
sendFailure | boolean |
Indique si l’envoi échoue. |
|
|
Envoyer détérioré
|
sendDegraded | boolean |
Indique si l’envoi est détérioré. |
|
|
Expiration SSL
|
sslExpiry | boolean |
Détermine si une alerte doit être envoyée pour l’expiration des certificats SSL. |
|
|
Seuil d’expiration SSL
|
sslExpiryThreshold | integer |
À quel moment dans le temps commencer à alerter sur les certificats SSL. |
Retours
- Corps
- AlertChannel
Mettre à jour un emplacement privé
Met à jour un emplacement privé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
Identificateur. |
|
Nom
|
name | True | string |
Nom attribué à l’emplacement privé. |
|
Icône
|
icon | string |
Icône. |
Retours
Mettre à jour un extrait de code
Met à jour un extrait de code.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
Identificateur. |
|
Nom
|
name | True | string |
Nom de l’extrait de code. |
|
Scénario
|
script | True | string |
Votre code Node.js qui interagit avec le cycle de vie de vérification de l’API ou fonctionne comme un élément partiel pour les vérifications de navigateur. |
Retours
- Corps
- Snippet
Mettre à jour un groupe de vérifications
Met à jour un groupe de vérifications.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
Identificateur. |
|
Attribuer automatiquement des alertes
|
autoAssignAlerts | boolean |
Détermine si une nouvelle vérification est automatiquement ajoutée en tant qu’abonné à tous les canaux d’alerte existants lors de sa création. |
|
|
Nom
|
name | string |
Nom du groupe de vérifications. |
|
|
Activated
|
activated | boolean |
Détermine si les vérifications dans le groupe sont en cours d’exécution ou non. |
|
|
Assourdi
|
muted | boolean |
Détermine si des notifications sont envoyées lorsqu’un enregistrement dans ce groupe échoue et/ou récupère. |
|
|
Vérifier la liste des étiquettes de groupe
|
tags | array of string |
Balises pour l’organisation et le filtrage des vérifications. |
|
|
Vérifier la liste d’emplacements du groupe
|
locations | array of string |
Tableau d’un ou plusieurs emplacements de centre de données où exécuter les vérifications. |
|
|
Concurrency
|
concurrency | number |
Détermine le nombre de vérifications appelées simultanément lors du déclenchement d’un groupe de vérifications à partir de CI/CD ou via l’API. |
|
|
URL
|
url | string |
URL de base de ce groupe que vous pouvez référencer avec la variable {{GROUP_BASE_URL}} dans toutes les vérifications de groupe. |
|
|
Key
|
key | True | string |
La clé. |
|
Valeur
|
value | True | string |
Valeur. |
|
Verrouillé
|
locked | boolean |
Indique s’il est verrouillé. |
|
|
Origine
|
source | string |
Source. |
|
|
Propriété
|
property | string |
Propriété. |
|
|
Comparison
|
comparison | string |
Comparaison. |
|
|
Cible
|
target | string |
Cible. |
|
|
Nom d’utilisateur
|
username | True | string |
Nom d’utilisateur. |
|
Mot de passe
|
password | True | string |
Mot de passe. |
|
Vérifier les valeurs par défaut de vérification du navigateur de création de groupe
|
browserCheckDefaults | object |
Le groupe de vérifications crée les valeurs par défaut de vérification du navigateur. |
|
|
ID d’exécution
|
runtimeId | string |
Version du runtime, c’est-à-dire ensemble fixe de dépendances d’exécution, utilisée pour exécuter des vérifications dans ce groupe. |
|
|
Key
|
key | True | string |
Clé de la variable d’environnement (cette valeur ne peut pas être modifiée). |
|
Valeur
|
value | True | string |
Valeur de la variable d’environnement. |
|
Verrouillé
|
locked | boolean |
Utilisé uniquement dans l’interface utilisateur pour masquer la valeur comme un mot de passe. |
|
|
Vérification double
|
doubleCheck | boolean |
La définition de cette valeur sur true déclenche une nouvelle tentative lorsqu’une vérification échoue à partir de la région défaillante et une autre région sélectionnée de manière aléatoire avant d’marquer la vérification comme ayant échoué. |
|
|
Utiliser les paramètres d’alerte globale
|
useGlobalAlertSettings | boolean |
Lorsque la valeur est true, le paramètre d’alerte au niveau du compte est utilisé, et non le paramètre d’alerte défini sur ce groupe de vérifications. |
|
|
Type d’escalade
|
escalationType | string |
Détermine le type d’escalade à utiliser. |
|
|
Seuil d’exécution ayant échoué
|
failedRunThreshold | number |
Après l’échec de la vérification consécutive, une notification d’alerte doit être envoyée. |
|
|
Seuil d’échec des minutes
|
minutesFailingThreshold | number |
Après le nombre de minutes après l’échec d’une vérification, une alerte doit être envoyée. |
|
|
Montant
|
amount | number |
Nombre de rappels à envoyer après la notification d’alerte initiale. |
|
|
Intervalle
|
interval | number |
À quel intervalle les rappels doivent être envoyés. |
|
|
Enabled
|
enabled | boolean |
Détermine si les notifications d’alerte doivent être envoyées pour l’expiration des certificats SSL. |
|
|
Seuil d’alerte
|
alertThreshold | integer |
À quel moment dans le temps commencer à alerter sur les certificats SSL. |
|
|
ID du canal d’alerte
|
alertChannelId | True | number |
Identificateur du canal d’alerte. |
|
Activated
|
activated | True | boolean |
Indique s’il est activé. |
|
ID d’extrait de code d’installation
|
setupSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase d’installation d’une vérification d’API dans ce groupe. |
|
|
ID de l’extrait de code de destruction
|
tearDownSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase de destruction d’une vérification d’API dans ce groupe. |
|
|
Script d’installation local
|
localSetupScript | string |
Élément valide de Node.js code à exécuter dans la phase d’installation d’une vérification d’API dans ce groupe. |
|
|
Script de destruction locale
|
localTearDownScript | string |
Élément de Node.js code valide à exécuter dans la phase de déblochage d’une vérification d’API dans ce groupe. |
|
|
Vérifier les emplacements privés
|
privateLocations | array of string |
Tableau d’un ou plusieurs emplacements privés où exécuter les vérifications. |
Retours
- Corps
- CheckGroup
Mettre à jour un tableau de bord
Met à jour un tableau de bord. Retourne un 409 lors de la tentative de création d’un tableau de bord avec une URL personnalisée ou un domaine personnalisé déjà pris.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
dashboardId | True | string |
Identificateur du tableau de bord. |
|
URL personnalisée
|
customUrl | string |
Nom de sous-domaine sous checklyhq.com. Doit être unique pour tous les utilisateurs. |
|
|
Domaine personnalisé
|
customDomain | string |
Un domaine d’utilisateur personnalisé, par exemple, status.example.com. Consultez les documents sur la mise à jour de votre utilisation DNS et SSL. |
|
|
Logo
|
logo | string |
URL pointant vers un fichier image. |
|
|
Favicon
|
favicon | string |
URL pointant vers un fichier image utilisé comme favicon de tableau de bord. |
|
|
Lien
|
link | string |
Lien d’URL à rediriger lorsque le logo du tableau de bord est cliqué dessus. |
|
|
Header
|
header | string |
Élément de texte affiché en haut de votre tableau de bord. |
|
|
Descriptif
|
description | string |
Élément de texte affiché sous l’en-tête ou le titre de votre tableau de bord. |
|
|
Largeur
|
width | string |
Détermine s’il faut utiliser l’écran plein ou le focus dans le centre. |
|
|
Taux d’actualisation
|
refreshRate | number |
Fréquence d’actualisation du tableau de bord en secondes. |
|
|
Paginer
|
paginate | boolean |
Détermine la pagination est activée ou désactivée. |
|
|
Taux de pagination
|
paginationRate | number |
Fréquence à laquelle déclencher la pagination en secondes. |
|
|
Vérifications par page
|
checksPerPage | number |
Nombre de vérifications affichées par page. |
|
|
Utiliser et opérateur
|
useTagsAndOperator | boolean |
Quand utiliser l’opérateur AND pour la recherche de balises. |
|
|
Masquer les étiquettes
|
hideTags | boolean |
Affichez ou masquez les balises dans le tableau de bord. |
|
|
Liste des balises du tableau de bord
|
tags | array of string |
Liste d’une ou de plusieurs balises qui filtrent les contrôles à afficher sur le tableau de bord. |
Retours
- Corps
- Dashboard
Mettre à jour une fenêtre de maintenance
Met à jour une fenêtre de maintenance.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
Identificateur. |
|
Nom
|
name | True | string |
Nom de la fenêtre de maintenance. |
|
Liste des balises de fenêtre de maintenance
|
tags | array of string |
Les noms de la fenêtre de maintenance des contrôles et des groupes doivent s’appliquer. |
|
|
Commence à
|
startsAt | True | date |
Date de début de la fenêtre de maintenance. |
|
Se termine à
|
endsAt | True | date |
Date de fin de la fenêtre de maintenance. |
|
Intervalle de répétition
|
repeatInterval | number |
Intervalle de répétition de la fenêtre de maintenance à partir de la première occurrence. |
|
|
Unité de répétition
|
repeatUnit | True | string |
Stratégie de répétition de la fenêtre de maintenance. |
|
Répéter les extrémités à
|
repeatEndsAt | date |
Date de fin où la fenêtre de maintenance doit cesser de se répéter. |
Retours
- Corps
- MaintenanceWindow
Mettre à jour une variable d’environnement
Met à jour une variable d’environnement. Utilise le champ clé comme identificateur pour la mise à jour. Met uniquement à jour la valeur et la propriété verrouillée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Key
|
key | True | string |
La clé. |
|
Key
|
key | string |
Clé de la variable d’environnement (cette valeur ne peut pas être modifiée). |
|
|
Valeur
|
value | True | string |
Valeur de la variable d’environnement. |
|
Verrouillé
|
locked | boolean |
Utilisé uniquement dans l’interface utilisateur pour masquer la valeur comme un mot de passe. |
Retours
- Corps
- EnvironmentVariable
Mettre à jour une vérification [DÉCONSEILLÉE]
[DÉCONSEILLÉ] Ce point de terminaison sera supprimé le lundi 4 juillet 2022. Utilisez plutôt PUT /checks/api/{id} ou PUT /checks/browser/{id}. Met à jour une nouvelle vérification de l’API ou du navigateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
Identificateur. |
|
Attribuer automatiquement des alertes
|
autoAssignAlerts | boolean |
Détermine si une nouvelle vérification est automatiquement ajoutée en tant qu’abonné à tous les canaux d’alerte existants lors de sa création. |
|
|
Nom
|
name | string |
Nom de la vérification. |
|
|
Activated
|
activated | boolean |
Détermine si la vérification est en cours d’exécution ou non. |
|
|
Assourdi
|
muted | boolean |
Détermine si des notifications sont envoyées lorsqu’une vérification échoue et/ou récupère. |
|
|
Vérification double
|
doubleCheck | boolean |
La définition de cette valeur sur true déclenche une nouvelle tentative lorsqu’une vérification échoue à partir de la région défaillante et une autre région sélectionnée de manière aléatoire avant d’marquer la vérification comme ayant échoué. |
|
|
Doit échouer
|
shouldFail | boolean |
Permet d’inverser le comportement de l’échec d’une vérification. Permet de valider l’état d’erreur comme 404. |
|
|
Vérifier la liste des emplacements
|
locations | array of string |
Tableau d’un ou plusieurs emplacements de centre de données où exécuter cette vérification. |
|
|
Vérifier la liste des balises
|
tags | array of string |
Balises pour l’organisation et le filtrage des vérifications. |
|
|
Type d’escalade
|
escalationType | string |
Détermine le type d’escalade à utiliser. |
|
|
Seuil d’exécution ayant échoué
|
failedRunThreshold | number |
Après l’échec de la vérification consécutive, une notification d’alerte doit être envoyée. |
|
|
Seuil d’échec des minutes
|
minutesFailingThreshold | number |
Après le nombre de minutes après l’échec d’une vérification, une alerte doit être envoyée. |
|
|
Montant
|
amount | number |
Nombre de rappels à envoyer après la notification d’alerte initiale. |
|
|
Intervalle
|
interval | number |
À quel intervalle les rappels doivent être envoyés. |
|
|
Enabled
|
enabled | boolean |
Détermine si les notifications d’alerte doivent être envoyées pour l’expiration des certificats SSL. |
|
|
Seuil d’alerte
|
alertThreshold | integer |
À quel moment dans le temps commencer à alerter sur les certificats SSL. |
|
|
Utiliser les paramètres d’alerte globale
|
useGlobalAlertSettings | boolean |
Lorsque la valeur est true, le paramètre d’alerte au niveau du compte est utilisé, et non le paramètre d’alerte défini sur cette vérification. |
|
|
ID de groupe
|
groupId | number |
L’identificateur du groupe de vérifications dont fait partie cette vérification. |
|
|
Ordre de groupe
|
groupOrder | number |
Position de cette vérification dans un groupe de vérifications. Il détermine dans quel ordre les vérifications sont exécutées lorsqu’un groupe est déclenché à partir de l’API ou de CI/CD. |
|
|
ID d’exécution
|
runtimeId | string |
La version du runtime, c’est-à-dire l’ensemble fixe de dépendances d’exécution, utilisé pour exécuter cette vérification. |
|
|
ID du canal d’alerte
|
alertChannelId | True | number |
Identificateur du canal d’alerte. |
|
Activated
|
activated | True | boolean |
Indique s’il est activé. |
|
Vérifier le type
|
checkType | string |
Type de la vérification. |
|
|
Fréquence
|
frequency | integer |
Fréquence à laquelle la vérification doit s’exécuter en minutes. |
|
|
Décalage de fréquence
|
frequencyOffset | integer |
Utilisé pour définir des secondes pour les fréquences de vérification de moins de 1 minutes (uniquement pour les vérifications d’API) et la répartition des vérifications sur une plage de temps pour les fréquences de plus de 1 minute. Cela fonctionne comme suit : Les vérifications avec une fréquence de 0 peuvent avoir une fréquenceOffset de 10, 20 ou 30, ce qui signifie qu’elles s’exécutent toutes les 10, 20 ou 30 secondes. Les vérifications avec une fréquence inférieure et égale à 60 peuvent avoir une fréquenceOffset comprise entre 1 et une valeur maximale basée sur la formule Math.floor(frequency * 10), c’est-à-dire pour une vérification qui s’exécute toutes les 5 minutes, la fréquence maximaleOffset est de 50. Les vérifications avec une fréquence supérieure à 60 peuvent avoir un frequencyOffset compris entre 1 et une valeur maximale basée sur la formule Math.ceil(frequency / 60), c’est-à-dire pour une vérification qui s’exécute toutes les 720 minutes, la fréquence maximaleOffset est 12. |
|
|
Vérifier la demande
|
request | True | object |
Demande de vérification. |
|
Scénario
|
script | True | string |
Script. |
|
Key
|
key | True | string |
Clé de la variable d’environnement (cette valeur ne peut pas être modifiée). |
|
Valeur
|
value | True | string |
Valeur de la variable d’environnement. |
|
Verrouillé
|
locked | boolean |
Utilisé uniquement dans l’interface utilisateur pour masquer la valeur comme un mot de passe. |
|
|
ID d’extrait de code d’installation
|
setupSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase d’installation d’une vérification d’API. |
|
|
ID de l’extrait de code de destruction
|
tearDownSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase de destruction d’une vérification d’API. |
|
|
Script d’installation local
|
localSetupScript | string |
Élément valide de Node.js code à exécuter dans la phase d’installation. |
|
|
Script de destruction locale
|
localTearDownScript | string |
Élément valide de Node.js code à exécuter dans la phase de déblochage. |
|
|
Temps de réponse détérioré
|
degradedResponseTime | number |
Temps de réponse en millisecondes où une vérification doit être considérée comme détériorée. |
|
|
Temps de réponse maximal
|
maxResponseTime | number |
Temps de réponse en millisecondes où une vérification doit être considérée comme défaillante. |
|
|
Emplacements privés
|
privateLocations | array of string |
Tableau d’un ou plusieurs emplacements privés où exécuter la vérification. |
Retours
- Corps
- Check
Mettre à jour une vérification du navigateur
Met à jour une vérification du navigateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
Identificateur. |
|
Attribuer automatiquement des alertes
|
autoAssignAlerts | boolean |
Détermine si une nouvelle vérification est automatiquement ajoutée en tant qu’abonné à tous les canaux d’alerte existants lors de sa création. |
|
|
Nom
|
name | string |
Nom de la vérification. |
|
|
Activated
|
activated | boolean |
Détermine si la vérification est en cours d’exécution ou non. |
|
|
Assourdi
|
muted | boolean |
Détermine si des notifications sont envoyées lorsqu’une vérification échoue et/ou récupère. |
|
|
Vérification double
|
doubleCheck | boolean |
La définition de cette valeur sur true déclenche une nouvelle tentative lorsqu’une vérification échoue à partir de la région défaillante et une autre région sélectionnée de manière aléatoire avant d’marquer la vérification comme ayant échoué. |
|
|
Doit échouer
|
shouldFail | boolean |
Permet d’inverser le comportement de l’échec d’une vérification. Permet de valider l’état d’erreur comme 404. |
|
|
Vérifier la liste des emplacements
|
locations | array of string |
Tableau d’un ou plusieurs emplacements de centre de données où exécuter cette vérification. |
|
|
Vérifier la liste des balises
|
tags | array of string |
Balises pour l’organisation et le filtrage des vérifications. |
|
|
Type d’escalade
|
escalationType | string |
Détermine le type d’escalade à utiliser. |
|
|
Seuil d’exécution ayant échoué
|
failedRunThreshold | number |
Après l’échec de la vérification consécutive, une notification d’alerte doit être envoyée. |
|
|
Seuil d’échec des minutes
|
minutesFailingThreshold | number |
Après le nombre de minutes après l’échec d’une vérification, une alerte doit être envoyée. |
|
|
Montant
|
amount | number |
Nombre de rappels à envoyer après la notification d’alerte initiale. |
|
|
Intervalle
|
interval | number |
À quel intervalle les rappels doivent être envoyés. |
|
|
Enabled
|
enabled | boolean |
Détermine si les notifications d’alerte doivent être envoyées pour l’expiration des certificats SSL. |
|
|
Seuil d’alerte
|
alertThreshold | integer |
À quel moment dans le temps commencer à alerter sur les certificats SSL. |
|
|
Utiliser les paramètres d’alerte globale
|
useGlobalAlertSettings | boolean |
Lorsque la valeur est true, le paramètre d’alerte au niveau du compte est utilisé, et non le paramètre d’alerte défini sur cette vérification. |
|
|
ID de groupe
|
groupId | number |
L’identificateur du groupe de vérifications dont fait partie cette vérification. |
|
|
Ordre de groupe
|
groupOrder | number |
Position de cette vérification dans un groupe de vérifications. Il détermine dans quel ordre les vérifications sont exécutées lorsqu’un groupe est déclenché à partir de l’API ou de CI/CD. |
|
|
ID d’exécution
|
runtimeId | string |
La version du runtime, c’est-à-dire l’ensemble fixe de dépendances d’exécution, utilisé pour exécuter cette vérification. |
|
|
ID du canal d’alerte
|
alertChannelId | True | number |
Identificateur du canal d’alerte. |
|
Activated
|
activated | True | boolean |
Indique s’il est activé. |
|
Key
|
key | True | string |
Clé de la variable d’environnement (cette valeur ne peut pas être modifiée). |
|
Valeur
|
value | True | string |
Valeur de la variable d’environnement. |
|
Verrouillé
|
locked | boolean |
Utilisé uniquement dans l’interface utilisateur pour masquer la valeur comme un mot de passe. |
|
|
Fréquence
|
frequency | integer |
Fréquence à laquelle la vérification doit s’exécuter en minutes. |
|
|
Scénario
|
script | string |
Élément valide de Node.js code javascript décrivant une interaction de navigateur avec les frameworks Puppeteer ou Playwright. |
|
|
Emplacements privés
|
privateLocations | array of string |
Tableau d’un ou plusieurs emplacements privés où exécuter la vérification. |
Retours
- Corps
- CheckBrowser
Mettre à jour une vérification d’API
Met à jour une vérification d’API.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
Identificateur. |
|
Attribuer automatiquement des alertes
|
autoAssignAlerts | boolean |
Détermine si une nouvelle vérification est automatiquement ajoutée en tant qu’abonné à tous les canaux d’alerte existants lors de sa création. |
|
|
Nom
|
name | string |
Nom de la vérification. |
|
|
Activated
|
activated | boolean |
Détermine si la vérification est en cours d’exécution ou non. |
|
|
Assourdi
|
muted | boolean |
Détermine si des notifications sont envoyées lorsqu’une vérification échoue et/ou récupère. |
|
|
Vérification double
|
doubleCheck | boolean |
La définition de cette valeur sur true déclenche une nouvelle tentative lorsqu’une vérification échoue à partir de la région défaillante et une autre région sélectionnée de manière aléatoire avant d’marquer la vérification comme ayant échoué. |
|
|
Doit échouer
|
shouldFail | boolean |
Permet d’inverser le comportement de l’échec d’une vérification. Permet de valider l’état d’erreur comme 404. |
|
|
Vérifier la liste des emplacements
|
locations | array of string |
Tableau d’un ou plusieurs emplacements de centre de données où exécuter cette vérification. |
|
|
Vérifier la liste des balises
|
tags | array of string |
Balises pour l’organisation et le filtrage des vérifications. |
|
|
Type d’escalade
|
escalationType | string |
Détermine le type d’escalade à utiliser. |
|
|
Seuil d’exécution ayant échoué
|
failedRunThreshold | number |
Après l’échec de la vérification consécutive, une notification d’alerte doit être envoyée. |
|
|
Seuil d’échec des minutes
|
minutesFailingThreshold | number |
Après le nombre de minutes après l’échec d’une vérification, une alerte doit être envoyée. |
|
|
Montant
|
amount | number |
Nombre de rappels à envoyer après la notification d’alerte initiale. |
|
|
Intervalle
|
interval | number |
À quel intervalle les rappels doivent être envoyés. |
|
|
Enabled
|
enabled | boolean |
Détermine si les notifications d’alerte doivent être envoyées pour l’expiration des certificats SSL. |
|
|
Seuil d’alerte
|
alertThreshold | integer |
À quel moment dans le temps commencer à alerter sur les certificats SSL. |
|
|
Utiliser les paramètres d’alerte globale
|
useGlobalAlertSettings | boolean |
Lorsque la valeur est true, le paramètre d’alerte au niveau du compte est utilisé, et non le paramètre d’alerte défini sur cette vérification. |
|
|
ID de groupe
|
groupId | number |
L’identificateur du groupe de vérifications dont fait partie cette vérification. |
|
|
Ordre de groupe
|
groupOrder | number |
Position de cette vérification dans un groupe de vérifications. Il détermine dans quel ordre les vérifications sont exécutées lorsqu’un groupe est déclenché à partir de l’API ou de CI/CD. |
|
|
ID d’exécution
|
runtimeId | string |
La version du runtime, c’est-à-dire l’ensemble fixe de dépendances d’exécution, utilisé pour exécuter cette vérification. |
|
|
ID du canal d’alerte
|
alertChannelId | True | number |
Identificateur du canal d’alerte. |
|
Activated
|
activated | True | boolean |
Indique s’il est activé. |
|
method
|
method | True | string | |
|
URL
|
url | True | string |
Adresse URL. |
|
Suivre les redirections
|
followRedirects | boolean |
Indique s’il faut suivre les redirections. |
|
|
Ignorer SSL
|
skipSSL | boolean |
Indique s’il faut ignorer SSL. |
|
|
Corps
|
body | string |
Le corps. |
|
|
Type de corps
|
bodyType | string |
Type de corps. |
|
|
Key
|
key | True | string |
La clé. |
|
Valeur
|
value | True | string |
Valeur. |
|
Verrouillé
|
locked | boolean |
Indique s’il est verrouillé. |
|
|
Origine
|
source | string |
Source. |
|
|
Propriété
|
property | string |
Propriété. |
|
|
Comparison
|
comparison | string |
Comparaison. |
|
|
Cible
|
target | string |
Cible. |
|
|
Nom d’utilisateur
|
username | True | string |
Nom d’utilisateur. |
|
Mot de passe
|
password | True | string |
Mot de passe. |
|
Fréquence
|
frequency | integer |
Fréquence à laquelle la vérification doit s’exécuter en minutes. |
|
|
ID de l’extrait de code de destruction
|
tearDownSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase de destruction d’une vérification d’API. |
|
|
ID d’extrait de code d’installation
|
setupSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase d’installation d’une vérification d’API. |
|
|
Décalage de fréquence
|
frequencyOffset | integer |
Utilisé pour définir des secondes pour les fréquences de vérification de moins de 1 minutes et la répartition des vérifications sur une plage de temps pour les fréquences supérieures à 1 minute. Cela fonctionne comme suit : Les vérifications avec une fréquence de 0 peuvent avoir une fréquenceOffset de 10, 20 ou 30, ce qui signifie qu’elles s’exécutent toutes les 10, 20 ou 30 secondes. Les vérifications avec une fréquence inférieure et égale à 60 peuvent avoir une fréquenceOffset comprise entre 1 et une valeur maximale basée sur la formule Math.floor(frequency * 10), c’est-à-dire pour une vérification qui s’exécute toutes les 5 minutes, la fréquence maximaleOffset est de 50. Les vérifications avec une fréquence supérieure à 60 peuvent avoir un frequencyOffset compris entre 1 et une valeur maximale basée sur la formule Math.ceil(frequency / 60), c’est-à-dire pour une vérification qui s’exécute toutes les 720 minutes, la fréquence maximaleOffset est 12. |
|
|
Script d’installation local
|
localSetupScript | string |
Élément valide de Node.js code à exécuter dans la phase d’installation. |
|
|
Script de destruction locale
|
localTearDownScript | string |
Élément valide de Node.js code à exécuter dans la phase de déblochage. |
|
|
Temps de réponse détérioré
|
degradedResponseTime | number |
Temps de réponse en millisecondes où une vérification doit être considérée comme détériorée. |
|
|
Temps de réponse maximal
|
maxResponseTime | number |
Temps de réponse en millisecondes où une vérification doit être considérée comme défaillante. |
|
|
Emplacements privés
|
privateLocations | array of string |
Tableau d’un ou plusieurs emplacements privés où exécuter la vérification. |
Retours
- Corps
- CheckAPI
Obtenir le badge d’état de vérification
Obtenir le badge d’état de vérification.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Vérifier l’ID
|
checkId | True | string |
Identificateur de vérification. |
|
Style
|
style | string |
Style. |
|
|
Thème
|
theme | string |
Thème. |
|
|
Temps de réponse
|
responseTime | boolean |
Heure de réponse. |
Retours
- response
- string
Obtenir le badge d’état du groupe
Obtenir le badge d’état du groupe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de groupe
|
groupId | True | integer |
Identificateur de groupe. |
|
Style
|
style | string |
Style. |
|
|
Thème
|
theme | string |
Thème. |
|
|
Temps de réponse
|
responseTime | boolean |
Heure de réponse. |
Retours
- response
- string
Obtenir le déclencheur de groupe de vérification
Recherche le déclencheur de groupe de vérification.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de groupe
|
groupId | True | integer |
Identificateur de groupe. |
Retours
- Corps
- CheckGroupTrigger
Obtenir le déclencheur de vérification
Recherche le déclencheur de vérification.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Vérifier l’ID
|
checkId | True | string |
Identificateur de vérification. |
Retours
- Corps
- CheckTrigger
Obtenir les métriques d’intégrité d’emplacement privé à partir d’une fenêtre de temps
Obtenez des métriques d’intégrité d’emplacement privé à partir d’une fenêtre de temps.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
Identificateur. |
|
De
|
from | True | date |
Sélectionnez les métriques commençant par cet horodatage UNIX. Doit être inférieur à 15 jours. |
|
À
|
to | True | date |
Sélectionnez les métriques jusqu’à cet horodatage UNIX. |
Retours
Récupérer les détails de l’état de vérification
Affichez les informations d’état actuelles pour une vérification spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Vérifier l’ID
|
checkId | True | string |
Identificateur de vérification. |
Retours
- Corps
- CheckStatus
Récupérer toutes les vérifications dans un groupe spécifique avec les paramètres de groupe appliqués
Répertorie toutes les vérifications dans un groupe de vérifications spécifique avec les paramètres de groupe appliqués.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
Identificateur. |
|
Limit
|
limit | integer |
Limitez le nombre de résultats. |
|
|
Number
|
page | number |
Numéro de page. |
Retours
- Objets
- Model8
Récupérer un canal d’alerte
Afficher les détails d’un canal d’alerte spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
Identificateur. |
Retours
- Corps
- AlertChannel
Récupérer un emplacement privé
Afficher les détails d’un emplacement privé spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
Identificateur. |
Retours
- Corps
- privatelocationschema
Récupérer un extrait de code
Afficher les détails d’un extrait de code spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
Identificateur. |
Retours
- Corps
- Snippet
Récupérer un groupe de vérifications
Afficher les détails d’un groupe de vérification spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
Identificateur. |
Retours
- Corps
- CheckGroup
Récupérer un résultat de vérification
Afficher les détails d’un résultat de vérification spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Vérifier l’ID
|
checkId | True | string |
Identificateur de vérification. |
|
Vérifier l’ID de résultat
|
checkResultId | True | string |
Identificateur de résultat de la vérification. |
Retours
- Corps
- CheckResult
Récupérer une fenêtre de maintenance
Afficher les détails d’une fenêtre de maintenance spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
Identificateur. |
Retours
- Corps
- MaintenanceWindow
Récupérer une variable d’environnement
Afficher les détails d’une variable d’environnement spécifique. Utilise le champ clé pour la sélection.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Key
|
key | True | string |
La clé. |
Retours
- Corps
- EnvironmentVariable
Récupérer une vérification
Afficher les détails d’une vérification spécifique de l’API ou du navigateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
Identificateur. |
Retours
- Corps
- Check
Récupérer une vérification dans un groupe spécifique avec les paramètres de groupe appliqués
Affichez les détails d’une vérification dans un groupe de vérification spécifique avec les paramètres de groupe appliqués.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de groupe
|
groupId | True | integer |
Identificateur de groupe. |
|
Vérifier l’ID
|
checkId | True | string |
Identificateur de vérification. |
Retours
- Corps
- CheckGroupCheck
Répertorie tous les emplacements pris en charge
Répertorie tous les runtimes pris en charge
Répertorie tous les runtimes pris en charge et les packages NPM inclus pour les vérifications du navigateur et l’installation des scripts de démontage pour les vérifications d’API.
Retours
- Objets
- RuntimeList
Répertorie tous les résultats de la vérification
Répertorie les résultats complets de la vérification brute pour une vérification spécifique. Nous conservons les résultats bruts pendant 30 jours. Après 30 jours, ils sont effacés. Toutefois, nous conservons les résultats enregistrés pendant une période indéfinie. Vous pouvez filtrer par type de vérification et type de résultat pour affiner la liste. Utilisez les paramètres et from les to paramètres pour spécifier une plage de dates (horodatage UNIX en secondes). Selon le type de vérification, certains champs peuvent être null. Ce point de terminaison retourne des données dans un délai de six heures. Si des params sont fixés, ils doivent être au plus six heures à part. Si aucun n’est défini, nous considérons que le param sera maintenant et de param à six heures plus tôt. Si seule la valeur param est définie, nous allons passer de six heures plus tôt. Au contraire, si seul le param est défini, nous considérerons que le param sera de six heures plus tard. La limitation du débit est appliquée à ce point de terminaison, vous pouvez envoyer 5 requêtes / 10 secondes au maximum.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Vérifier l’ID
|
checkId | True | string |
Identificateur de vérification. |
|
Limit
|
limit | integer |
Limitez le nombre de résultats. |
|
|
Number
|
page | number |
Numéro de page. |
|
|
De
|
from | date |
Sélectionnez des documents à partir de cet horodatage UNIX (>= date). La valeur par défaut est maintenant : 6 heures. |
|
|
À
|
to | date |
Sélectionnez des alertes jusqu’à cet horodatage UNIX (< date). La valeur par défaut est de 6 heures après. |
|
|
Emplacement
|
location | string |
Fournir un emplacement de centre de données, par exemple eu-west-1 pour filtrer par emplacement |
|
|
Vérifier le type
|
checkType | string |
Type de la vérification. |
|
|
A des échecs
|
hasFailures | boolean |
Le résultat de la vérification a un ou plusieurs échecs. |
Retours
- Objets
- CheckResultList
Répertorier les alertes pour une vérification spécifique
Répertorie toutes les alertes pour une vérification spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Vérifier l’ID
|
checkId | True | string |
Identificateur de vérification. |
|
Limit
|
limit | integer |
Limitez le nombre de résultats. |
|
|
Number
|
page | number |
Numéro de page. |
|
|
De
|
from | date |
Sélectionnez des documents à partir de cet horodatage UNIX (>= date). La valeur par défaut est maintenant : 6 heures. |
|
|
À
|
to | date |
Sélectionnez des alertes jusqu’à cet horodatage UNIX (< date). La valeur par défaut est de 6 heures après. |
Retours
- Objets
- CheckAlertList
Répertorier tous les canaux d’alerte
Répertorie tous les canaux d’alerte configurés et leurs vérifications abonnées.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Limitez le nombre de résultats. |
|
|
Number
|
page | number |
Numéro de page. |
Retours
- Objets
- AlertChannelList
Répertorier tous les emplacements privés
Répertorier tous les extraits de code
Répertorie tous les extraits de code actuels dans votre compte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Limitez le nombre de résultats. |
|
|
Number
|
page | number |
Numéro de page. |
Retours
- Objets
- SnippetList
Répertorier tous les groupes de vérifications
Répertorie tous les groupes de vérification actuels dans votre compte. La propriété de vérification est un tableau de vérifications UUID pour référencer facilement. Il est en lecture seule et vous ne pouvez pas l’utiliser pour ajouter des vérifications à un groupe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Limitez le nombre de résultats. |
|
|
Number
|
page | number |
Numéro de page. |
Retours
- Objets
- CheckGroupList
Répertorier tous les tableaux de bord
Répertorie tous les tableaux de bord actuels dans votre compte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Limitez le nombre de résultats. |
|
|
Number
|
page | number |
Numéro de page. |
Retours
- Objets
- DashboardsList
Répertorier tous les états de vérification
Affiche les informations d’état actuelles pour toutes les vérifications dans votre compte. Les enregistrements d’état de vérification sont mis à jour en permanence à mesure que les nouveaux résultats de vérification sont ajoutés.
Retours
- Objets
- CheckStatusList
Répertorier toutes les alertes pour votre compte
Répertorie toutes les alertes de votre compte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Limitez le nombre de résultats. |
|
|
Number
|
page | number |
Numéro de page. |
|
|
De
|
from | date |
Sélectionnez des documents à partir de cet horodatage UNIX (>= date). La valeur par défaut est maintenant : 6 heures. |
|
|
À
|
to | date |
Sélectionnez des alertes jusqu’à cet horodatage UNIX (< date). La valeur par défaut est de 6 heures après. |
Retours
- Objets
- CheckAlertList
Répertorier toutes les fenêtres de maintenance
Répertorie toutes les fenêtres de maintenance de votre compte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Limitez le nombre de résultats. |
|
|
Number
|
page | number |
Numéro de page. |
Retours
Liste des fenêtres de maintenance.
- Objets
- MaintenanceWindowList
Répertorier toutes les variables d’environnement
Répertorie toutes les variables d’environnement actuelles dans votre compte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Limitez le nombre de résultats. |
|
|
Number
|
page | number |
Numéro de page. |
Retours
- Objets
- EnvironmentVariableList
Répertorier toutes les vérifications
Répertorie toutes les vérifications actuelles dans votre compte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Limitez le nombre de résultats. |
|
|
Number
|
page | number |
Numéro de page. |
|
|
Filtre d’URL de vérification de l’API
|
apiCheckUrlFilterPattern | string |
Filtre les résultats par une chaîne contenue dans l’URL d’une vérification d’API, par exemple un domaine comme www.myapp.com. Retourne uniquement les vérifications d’API. |
Retours
- Objets
- CheckList
Supprimer le déclencheur de groupe de vérification
Supprime le déclencheur de groupes de vérifications.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de groupe
|
groupId | True | integer |
Identificateur de groupe. |
Supprimer le déclencheur de vérification
Supprime le déclencheur de vérification.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Vérifier l’ID
|
checkId | True | string |
Identificateur de vérification. |
Supprimer un canal d’alerte
Supprime définitivement un canal d’alerte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
Identificateur. |
Supprimer un emplacement privé
Supprime définitivement un emplacement privé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
Identificateur. |
Supprimer un extrait de code
Supprime définitivement un extrait de code.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
Identificateur. |
Supprimer un groupe de vérifications
Supprime définitivement un groupe de vérifications. Vous ne pouvez pas supprimer un groupe de vérifications s’il contient toujours des vérifications.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
Identificateur. |
Supprimer un tableau de bord
Supprime définitivement un tableau de bord.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
dashboardId | True | string |
Identificateur du tableau de bord. |
Supprimer une clé API existante pour un emplacement privé
Supprime définitivement une clé API d’un emplacement privé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
Identificateur. |
|
ID de clé
|
keyId | True | string |
Identificateur de clé. |
Supprimer une fenêtre de maintenance
Supprime définitivement une fenêtre de maintenance.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
Identificateur. |
Supprimer une variable d’environnement
Supprime définitivement une variable d’environnement. Utilise le champ de clé comme identificateur pour la suppression.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Key
|
key | True | string |
La clé. |
Supprimer une vérification
Supprime définitivement une vérification d’API ou de navigateur et toutes ses données d’état et de résultats associées.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
Identificateur. |
Définitions
AlertChannelConfig
Configuration du canal d’alerte.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Configuration du canal d’alerte
|
object |
Configuration du canal d’alerte. |
AlertChanelSubscription
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | number |
Identificateur. |
|
Vérifier l’ID
|
checkId | guid |
Identificateur de vérification. |
|
ID de groupe
|
groupId | number |
Identificateur de groupe. |
|
Activated
|
activated | boolean |
Indique s’il est activé. |
AlertChanelSubscriptionList
Toutes les vérifications sont abonnées à ce canal.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
AlertChanelSubscription |
AlertChannel
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | number |
Identificateur. |
|
Type
|
type | string |
Type de canal d’alerte, c’est-à-dire e-mail ou SLACK. |
|
Configuration du canal d’alerte
|
config | AlertChannelConfig |
Configuration du canal d’alerte. |
|
Liste des abonnements du canal d’alerte
|
subscriptions | AlertChanelSubscriptionList |
Toutes les vérifications sont abonnées à ce canal. |
|
Envoyer la récupération
|
sendRecovery | boolean |
Indique si la récupération est envoyée. |
|
Échec d’envoi
|
sendFailure | boolean |
Indique si l’envoi échoue. |
|
Envoyer détérioré
|
sendDegraded | boolean |
Indique si l’envoi est détérioré. |
|
Expiration SSL
|
sslExpiry | boolean |
Détermine si une alerte doit être envoyée pour l’expiration des certificats SSL. |
|
Seuil d’expiration SSL
|
sslExpiryThreshold | integer |
À quel moment dans le temps commencer à alerter sur les certificats SSL. |
|
Créé à
|
created_at | date-time |
Quand il est créé à l’adresse. |
|
Mise à jour à
|
updated_at | date-time |
Lorsqu’il est mis à jour à l’adresse. |
AlertChannelList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
AlertChannel |
CheckAlert
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Identificateur unique de cette alerte. |
|
Nom
|
name | string |
Nom de la vérification. |
|
Vérifier l’ID
|
checkId | string |
Identificateur de la vérification à laquelle appartient cette alerte. |
|
Type d’alerte
|
alertType | string |
Type d’alerte. |
|
Vérifier le type
|
checkType | string |
Type de la vérification. |
|
Exécuter l’emplacement
|
runLocation | string |
L’emplacement du centre de données à partir duquel cette alerte de vérification a été déclenchée. |
|
Temps de réponse
|
responseTime | number |
Décrit le temps nécessaire à l’exécution des parties pertinentes de cette vérification. Toute heure système du minuteur de configuration nécessaire pour démarrer l’exécution de cette vérification dans le back-end Checkly ne fait pas partie de cela. |
|
Erreur
|
error | string |
Tous les messages d’erreur spécifiques qui faisaient partie de la vérification défaillante déclenchant l’alerte. |
|
Code de statut
|
statusCode | string |
Code d’état de la réponse. S’applique uniquement aux vérifications d’API. |
|
Créé à
|
created_at | date |
Date et heure de création de cette alerte de vérification. |
|
Démarré à
|
startedAt | date |
Date et heure de démarrage de cette alerte de vérification. |
CheckAlertList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
CheckAlert |
CheckGroupTagList
Balises pour l’organisation et le filtrage des vérifications.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
string |
CheckGroupLocationList
Tableau d’un ou plusieurs emplacements de centre de données où exécuter les vérifications.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
string |
KeyValue
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Key
|
key | string |
La clé. |
|
Valeur
|
value | string |
Valeur. |
|
Verrouillé
|
locked | boolean |
Indique s’il est verrouillé. |
HeaderList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
KeyValue |
QueryParameterList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
KeyValue |
Assertion
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Origine
|
source | string |
Source. |
|
Propriété
|
property | string |
Propriété. |
|
Comparison
|
comparison | string |
Comparaison. |
|
Cible
|
target | string |
Cible. |
AssertionList
Consultez la documentation principale sur les assertions pour des valeurs spécifiques telles que les expressions régulières et les descripteurs de chemin JSON que vous pouvez utiliser dans le champ de propriété.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
Assertion |
BasicAuth
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom d’utilisateur
|
username | string |
Nom d’utilisateur. |
|
Mot de passe
|
password | string |
Mot de passe. |
CheckGroupAPICheckDefaults
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
URL
|
url | string |
URL de base de ce groupe que vous pouvez référencer avec la variable {{GROUP_BASE_URL}} dans toutes les vérifications de groupe. |
|
headers
|
headers | HeaderList | |
|
queryParameters
|
queryParameters | QueryParameterList | |
|
Liste d’assertions
|
assertions | AssertionList |
Consultez la documentation principale sur les assertions pour des valeurs spécifiques telles que les expressions régulières et les descripteurs de chemin JSON que vous pouvez utiliser dans le champ de propriété. |
|
basicAuth
|
basicAuth | BasicAuth |
CheckGroupBrowserCheckDefaults
La vérification par défaut du navigateur de groupe de vérifications.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Vérifier les valeurs par défaut du navigateur de groupe
|
object |
La vérification par défaut du navigateur de groupe de vérifications. |
EnvironmentVariable
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Key
|
key | string |
Clé de la variable d’environnement (cette valeur ne peut pas être modifiée). |
|
Valeur
|
value | string |
Valeur de la variable d’environnement. |
|
Verrouillé
|
locked | boolean |
Utilisé uniquement dans l’interface utilisateur pour masquer la valeur comme un mot de passe. |
EnvironmentVariableList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
EnvironmentVariable |
AlertSettingsRunBasedEscalation
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Seuil d’exécution ayant échoué
|
failedRunThreshold | number |
Après l’échec de la vérification consécutive, une notification d’alerte doit être envoyée. |
AlertSettingsTimeBasedEscalation
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Seuil d’échec des minutes
|
minutesFailingThreshold | number |
Après le nombre de minutes après l’échec d’une vérification, une alerte doit être envoyée. |
AlertSettingsReminders
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Montant
|
amount | number |
Nombre de rappels à envoyer après la notification d’alerte initiale. |
|
Intervalle
|
interval | number |
À quel intervalle les rappels doivent être envoyés. |
AlertSettingsSSLCertificates
[DÉCONSEILLÉ] sslCertificates est déconseillé et n’est plus utilisé. Veuillez l’ignorer, sera supprimée dans une version ultérieure.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Enabled
|
enabled | boolean |
Détermine si les notifications d’alerte doivent être envoyées pour l’expiration des certificats SSL. |
|
Seuil d’alerte
|
alertThreshold | integer |
À quel moment dans le temps commencer à alerter sur les certificats SSL. |
CheckGroupAlertSettings
Paramètres d’alerte.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Type d’escalade
|
escalationType | string |
Détermine le type d’escalade à utiliser. |
|
runBasedEscalation
|
runBasedEscalation | AlertSettingsRunBasedEscalation | |
|
timeBasedEscalation
|
timeBasedEscalation | AlertSettingsTimeBasedEscalation | |
|
Rappels
|
reminders | AlertSettingsReminders | |
|
Certificats SSL des paramètres d’alerte
|
sslCertificates | AlertSettingsSSLCertificates |
[DÉCONSEILLÉ] |
Model1
Abonnement au canal d’alerte.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID du canal d’alerte
|
alertChannelId | number |
Identificateur du canal d’alerte. |
|
Activated
|
activated | boolean |
Indique s’il est activé. |
AlertChannelSubscriptionCreateList
Liste des abonnements au canal d’alerte.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Abonnement au canal d’alerte
|
Model1 |
Abonnement au canal d’alerte. |
privateLocations
Tableau d’un ou plusieurs emplacements privés où exécuter la vérification.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
string |
CheckGroup
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | number |
Identificateur. |
|
Nom
|
name | string |
Nom du groupe de vérifications. |
|
Activated
|
activated | boolean |
Détermine si les vérifications dans le groupe sont en cours d’exécution ou non. |
|
Assourdi
|
muted | boolean |
Détermine si des notifications sont envoyées lorsqu’un enregistrement dans ce groupe échoue et/ou récupère. |
|
Vérifier la liste des étiquettes de groupe
|
tags | CheckGroupTagList |
Balises pour l’organisation et le filtrage des vérifications. |
|
Vérifier la liste d’emplacements du groupe
|
locations | CheckGroupLocationList |
Tableau d’un ou plusieurs emplacements de centre de données où exécuter les vérifications. |
|
Concurrency
|
concurrency | number |
Détermine le nombre de vérifications appelées simultanément lors du déclenchement d’un groupe de vérifications à partir de CI/CD ou via l’API. |
|
apiCheckDefaults
|
apiCheckDefaults | CheckGroupAPICheckDefaults | |
|
Vérifier les valeurs par défaut du navigateur de groupe
|
browserCheckDefaults | CheckGroupBrowserCheckDefaults |
La vérification par défaut du navigateur de groupe de vérifications. |
|
environmentVariables
|
environmentVariables | EnvironmentVariableList | |
|
Vérification double
|
doubleCheck | boolean |
La définition de cette valeur sur true déclenche une nouvelle tentative lorsqu’une vérification échoue à partir de la région défaillante et une autre région sélectionnée de manière aléatoire avant d’marquer la vérification comme ayant échoué. |
|
Utiliser les paramètres d’alerte globale
|
useGlobalAlertSettings | boolean |
Lorsque la valeur est true, le paramètre d’alerte au niveau du compte est utilisé, et non le paramètre d’alerte défini sur ce groupe de vérifications. |
|
Vérifier les paramètres d’alerte de groupe
|
alertSettings | CheckGroupAlertSettings |
Paramètres d’alerte. |
|
Liste de création d’un abonnement au canal d’alerte
|
alertChannelSubscriptions | AlertChannelSubscriptionCreateList |
Liste des abonnements au canal d’alerte. |
|
ID d’extrait de code d’installation
|
setupSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase d’installation d’une vérification d’API dans ce groupe. |
|
ID de l’extrait de code de destruction
|
tearDownSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase de destruction d’une vérification d’API dans ce groupe. |
|
Script d’installation local
|
localSetupScript | string |
Élément valide de Node.js code à exécuter dans la phase d’installation d’une vérification d’API dans ce groupe. |
|
Script de destruction locale
|
localTearDownScript | string |
Élément de Node.js code valide à exécuter dans la phase de déblochage d’une vérification d’API dans ce groupe. |
|
ID d’exécution
|
runtimeId | string |
Version du runtime, c’est-à-dire ensemble fixe de dépendances d’exécution, utilisée pour exécuter des vérifications dans ce groupe. |
|
Emplacements privés
|
privateLocations | privateLocations |
Tableau d’un ou plusieurs emplacements privés où exécuter la vérification. |
|
Créé à
|
created_at | date |
Quand il est créé à l’adresse. |
|
Mise à jour à
|
updated_at | date-time |
Lorsqu’il est mis à jour à l’adresse. |
CheckGroupList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
CheckGroup |
CheckLocationList
Tableau d’un ou plusieurs emplacements de centre de données où exécuter cette vérification.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
string |
CheckTagList
Balises pour l’organisation et le filtrage des vérifications.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
string |
CheckAlertSettings
Paramètres d’alerte.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Type d’escalade
|
escalationType | string |
Détermine le type d’escalade à utiliser. |
|
runBasedEscalation
|
runBasedEscalation | AlertSettingsRunBasedEscalation | |
|
timeBasedEscalation
|
timeBasedEscalation | AlertSettingsTimeBasedEscalation | |
|
Rappels
|
reminders | AlertSettingsReminders | |
|
Certificats SSL des paramètres d’alerte
|
sslCertificates | AlertSettingsSSLCertificates |
[DÉCONSEILLÉ] |
CheckAlertChannelSubscription
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID du canal d’alerte
|
alertChannelId | number |
Identificateur du canal d’alerte. |
|
Activated
|
activated | boolean |
Indique s’il est activé. |
CheckAlertChannelSubscriptionList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
CheckAlertChannelSubscription |
CheckRequest
Demande de vérification.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Vérifier la demande
|
object |
Demande de vérification. |
CheckEnvironmentVariableList
Paires clé/valeur pour définir des variables d’environnement pendant l’exécution de la vérification. Celles-ci sont uniquement pertinentes pour les vérifications du navigateur. Utilisez des variables d’environnement globales dans la mesure du possible.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
EnvironmentVariable |
CheckAlertEmail
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Adresse
|
address | string |
Adresse. |
CheckAlertEmailList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
CheckAlertEmail |
Model4
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
KeyValue |
Model5
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
KeyValue |
CheckAlertWebhook
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
name | string |
Nom. |
|
URL
|
url | string |
Adresse URL. |
|
Méthode
|
method | string |
Méthode. |
|
headers
|
headers | Model4 | |
|
queryParameters
|
queryParameters | Model5 |
CheckAlertWebhookList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
CheckAlertWebhook |
CheckAlertSlack
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
URL
|
url | string |
Adresse URL. |
CheckAlertSlackList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
CheckAlertSlack |
CheckAlertSMS
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Number
|
number | string |
Nombre. |
|
Nom
|
name | string |
Nom. |
CheckAlertSMSList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
CheckAlertSMS |
CheckAlertChannels
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Messagerie électronique
|
CheckAlertEmailList | ||
|
point d'ancrage web (webhook)
|
webhook | CheckAlertWebhookList | |
|
lâche
|
slack | CheckAlertSlackList | |
|
SMS
|
sms | CheckAlertSMSList |
CheckGroupCheck
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
Nom
|
name | string |
Nom de la vérification. |
|
Activated
|
activated | boolean |
Détermine si la vérification est en cours d’exécution ou non. |
|
Assourdi
|
muted | boolean |
Détermine si des notifications sont envoyées lorsqu’une vérification échoue et/ou récupère. |
|
Vérification double
|
doubleCheck | boolean |
La définition de cette valeur sur true déclenche une nouvelle tentative lorsqu’une vérification échoue à partir de la région défaillante et une autre région sélectionnée de manière aléatoire avant d’marquer la vérification comme ayant échoué. |
|
Doit échouer
|
shouldFail | boolean |
Permet d’inverser le comportement de l’échec d’une vérification. Permet de valider l’état d’erreur comme 404. |
|
Vérifier la liste des emplacements
|
locations | CheckLocationList |
Tableau d’un ou plusieurs emplacements de centre de données où exécuter cette vérification. |
|
Vérifier la liste des balises
|
tags | CheckTagList |
Balises pour l’organisation et le filtrage des vérifications. |
|
Vérifier les paramètres d’alerte
|
alertSettings | CheckAlertSettings |
Paramètres d’alerte. |
|
Utiliser les paramètres d’alerte globale
|
useGlobalAlertSettings | boolean |
Lorsque la valeur est true, le paramètre d’alerte au niveau du compte est utilisé, et non le paramètre d’alerte défini sur cette vérification. |
|
ID de groupe
|
groupId | number |
L’identificateur du groupe de vérifications dont fait partie cette vérification. |
|
Ordre de groupe
|
groupOrder | number |
Position de cette vérification dans un groupe de vérifications. Il détermine dans quel ordre les vérifications sont exécutées lorsqu’un groupe est déclenché à partir de l’API ou de CI/CD. |
|
ID d’exécution
|
runtimeId | string |
La version du runtime, c’est-à-dire l’ensemble fixe de dépendances d’exécution, utilisé pour exécuter cette vérification. |
|
alertChannelSubscriptions
|
alertChannelSubscriptions | CheckAlertChannelSubscriptionList | |
|
Vérifier le type
|
checkType | string |
Type de la vérification. |
|
Fréquence
|
frequency | integer |
Fréquence à laquelle la vérification doit s’exécuter en minutes. |
|
Décalage de fréquence
|
frequencyOffset | integer |
Décalage de fréquence. |
|
Vérifier la demande
|
request | CheckRequest |
Demande de vérification. |
|
Scénario
|
script | string |
Script. |
|
Vérifier la liste des variables d’environnement
|
environmentVariables | CheckEnvironmentVariableList |
Paires clé/valeur pour définir des variables d’environnement pendant l’exécution de la vérification. Celles-ci sont uniquement pertinentes pour les vérifications du navigateur. Utilisez des variables d’environnement globales dans la mesure du possible. |
|
ID d’extrait de code d’installation
|
setupSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase d’installation d’une vérification d’API. |
|
ID de l’extrait de code de destruction
|
tearDownSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase de destruction d’une vérification d’API. |
|
Script d’installation local
|
localSetupScript | string |
Élément valide de Node.js code à exécuter dans la phase d’installation. |
|
Script de destruction locale
|
localTearDownScript | string |
Élément valide de Node.js code à exécuter dans la phase de déblochage. |
|
Temps de réponse détérioré
|
degradedResponseTime | number |
Temps de réponse en millisecondes où une vérification doit être considérée comme détériorée. |
|
Temps de réponse maximal
|
maxResponseTime | number |
Temps de réponse en millisecondes où une vérification doit être considérée comme défaillante. |
|
alertChannels
|
alertChannels | CheckAlertChannels | |
|
Emplacements privés
|
privateLocations | privateLocations |
Tableau d’un ou plusieurs emplacements privés où exécuter la vérification. |
|
Créé à
|
created_at | date |
Quand il est créé à l’adresse. |
|
Mise à jour à
|
updated_at | date-time |
Lorsqu’il est mis à jour à l’adresse. |
Model8
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
CheckGroupCheck |
Affirmations
Liste des assertions de vérification d’API.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
string |
headers
En-têtes.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
headers
|
object |
En-têtes. |
params
Paramètres.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Params
|
object |
Paramètres. |
request
Demande de l’API.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
method
|
method | string | |
|
URL
|
url | string | |
|
données
|
data | string | |
|
headers
|
headers | headers |
En-têtes. |
|
Params
|
params | params |
Paramètres. |
Horaires
Le minutage.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Horaires
|
object |
Le minutage. |
minutagephases
Phases de minutage.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Phases de minutage
|
object |
Phases de minutage. |
response
Réponse de l’API.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Statut
|
status | number |
État. |
|
Texte d’état
|
statusText | string |
Texte d’état. |
|
Corps
|
body | string |
Le corps. |
|
headers
|
headers | headers |
En-têtes. |
|
Horaires
|
timings | timings |
Le minutage. |
|
Phases de minutage
|
timingPhases | timingPhases |
Phases de minutage. |
jobLog
Journal des travaux.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Journal des travaux
|
object |
Journal des travaux. |
jobAssets
Ressources générées à partir de l’exécution de la vérification.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
string |
CheckResultAPI
Données de réponse pour une vérification d’API.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Assertions
|
assertions | assertions |
Liste des assertions de vérification d’API. |
|
Requête
|
request | request |
Demande de l’API. |
|
Réponse
|
response | response |
Réponse de l’API. |
|
Erreur de requête
|
requestError | string |
Décrit si une erreur s’est produite sur la demande. |
|
Journal des travaux
|
jobLog | jobLog |
Journal des travaux. |
|
Ressources de travail
|
jobAssets | jobAssets |
Ressources générées à partir de l’exécution de la vérification. |
Erreurs
Liste des erreurs sur l’exécution de la vérification.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
string |
Model9
Vérifiez les résultats du journal d’exécution.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
string |
traceSummary
Résumé de la trace.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Résumé de la trace
|
object |
Résumé de la trace. |
Pages
Liste des pages utilisées lors de l’exécution de la vérification.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
string |
CheckResultBrowser
Données de réponse pour une vérification du navigateur.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Type
|
type | string |
Type d’infrastructure utilisé par la vérification. |
|
Errors
|
errors | errors |
Liste des erreurs sur l’exécution de la vérification. |
|
Heure de fin
|
endTime | number |
Heure de fin de l’exécution de la vérification. |
|
Heure de début
|
startTime | number |
Heure de début de l’exécution de la vérification. |
|
Version d’exécution
|
runtimeVersion | string |
Version du runtime actif. |
|
Vérifier le journal d’exécution
|
jobLog | Model9 |
Vérifiez les résultats du journal d’exécution. |
|
Ressources de travail
|
jobAssets | jobAssets |
Ressources générées à partir de l’exécution de la vérification. |
|
Résumé de la trace
|
traceSummary | traceSummary |
Résumé de la trace. |
|
Feuilles
|
pages | pages |
Liste des pages utilisées lors de l’exécution de la vérification. |
CheckResult
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Identificateur unique de ce résultat. |
|
Nom
|
name | string |
Nom de la vérification. |
|
Vérifier l’ID
|
checkId | string |
Identificateur de la vérification. |
|
A des échecs
|
hasFailures | boolean |
Décrit si une défaillance s’est produite pendant cette exécution de vérification. Il doit s’agir de votre principal focus pour évaluer le comportement de vérification de l’API ou du navigateur. Les assertions qui échouent, délai d’attente ou scripts défaillants sont toutes résolues à cette valeur en étant vraies. |
|
A des erreurs
|
hasErrors | boolean |
Décrit si une erreur interne s’est produite dans le back-end de Checkly. Cela devrait être faux dans presque tous les cas. |
|
Est détérioré
|
isDegraded | boolean |
Une vérification est détériorée si elle dépasse la limite de dégradation définie par le champ de détériorationResponseTime sur la vérification. S’applique uniquement aux vérifications d’API. |
|
Durée de réponse maximale
|
overMaxResponseTime | boolean |
Défini sur true si le temps de réponse dépasse la limite définie par le champ maxResponseTime sur la vérification. S’applique uniquement aux vérifications d’API. |
|
Exécuter l’emplacement
|
runLocation | string |
L’emplacement du centre de données à partir duquel provient ce résultat de vérification. |
|
Démarré à
|
startedAt | date-time |
Le début à l’heure. |
|
Arrêté à
|
stoppedAt | date-time |
Arrêté à l’heure. |
|
Créé à
|
created_at | date-time |
Quand il est créé à l’adresse. |
|
Temps de réponse
|
responseTime | number |
Décrit le temps nécessaire à l’exécution des parties pertinentes de cette vérification. Toute heure système du minuteur de configuration nécessaire pour démarrer l’exécution de cette vérification dans le back-end Checkly ne fait pas partie de cela. |
|
API Vérifier le résultat
|
apiCheckResult | CheckResultAPI |
Données de réponse pour une vérification d’API. |
|
Résultat de la vérification du navigateur
|
browserCheckResult | CheckResultBrowser |
Données de réponse pour une vérification du navigateur. |
|
Vérifier l’ID d’exécution
|
checkRunId | number |
Identificateur de l’exécution de vérification spécifique qui a créé ce résultat de vérification. |
|
Tentatives
|
attempts | number |
Fréquence à laquelle cette vérification a été retentée. Cette valeur est supérieure à 0 lorsque la vérification double est activée. |
CheckResultList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
CheckResult |
CheckStatus
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
name | string |
Nom de la vérification. |
|
Vérifier l’ID
|
checkId | string |
Identificateur de vérification auquel cet état appartient. |
|
A des échecs
|
hasFailures | boolean |
Décrit si cette vérification échoue actuellement. Si l’une des assertions d’une vérification de l’API échoue, cette valeur a la valeur true. Si une vérification du navigateur échoue pour une raison quelconque, cela est vrai. |
|
A des erreurs
|
hasErrors | boolean |
Décrit si en raison d’une erreur en dehors de l’opération normale, cette vérification échoue. Cela doit être extrêmement rare et uniquement en cas d’erreur dans le back-end Checkly. |
|
Est détérioré
|
isDegraded | boolean |
Une vérification est détériorée si elle dépasse la limite de dégradation définie par le champ de détériorationResponseTime sur la vérification. S’applique uniquement aux vérifications d’API. |
|
Exécution la plus longue
|
longestRun | number |
Temps de réponse enregistré le plus long pour cette vérification. |
|
Exécution la plus courte
|
shortestRun | number |
Temps de réponse enregistré le plus court pour cette vérification. |
|
Emplacement de la dernière exécution
|
lastRunLocation | string |
À quel emplacement cette vérification a été exécutée pour la dernière fois. |
|
ID d’exécution de la dernière vérification
|
lastCheckRunId | string |
Identificateur d’incrémentation unique pour chaque exécution de vérification. |
|
Jours SSL restants
|
sslDaysRemaining | number |
Combien de jours restent jusqu’à l’expiration du certificat SSL actuel. |
|
Créé à
|
created_at | date |
Quand il est créé à l’adresse. |
|
Mise à jour à
|
updated_at | date-time |
Lorsqu’il est mis à jour à l’adresse. |
CheckStatusList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
CheckStatus |
Vérifier
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
Nom
|
name | string |
Nom de la vérification. |
|
Activated
|
activated | boolean |
Détermine si la vérification est en cours d’exécution ou non. |
|
Assourdi
|
muted | boolean |
Détermine si des notifications sont envoyées lorsqu’une vérification échoue et/ou récupère. |
|
Vérification double
|
doubleCheck | boolean |
La définition de cette valeur sur true déclenche une nouvelle tentative lorsqu’une vérification échoue à partir de la région défaillante et une autre région sélectionnée de manière aléatoire avant d’marquer la vérification comme ayant échoué. |
|
Doit échouer
|
shouldFail | boolean |
Permet d’inverser le comportement de l’échec d’une vérification. Permet de valider l’état d’erreur comme 404. |
|
Vérifier la liste des emplacements
|
locations | CheckLocationList |
Tableau d’un ou plusieurs emplacements de centre de données où exécuter cette vérification. |
|
Vérifier la liste des balises
|
tags | CheckTagList |
Balises pour l’organisation et le filtrage des vérifications. |
|
Vérifier les paramètres d’alerte
|
alertSettings | CheckAlertSettings |
Paramètres d’alerte. |
|
Utiliser les paramètres d’alerte globale
|
useGlobalAlertSettings | boolean |
Lorsque la valeur est true, le paramètre d’alerte au niveau du compte est utilisé, et non le paramètre d’alerte défini sur cette vérification. |
|
ID de groupe
|
groupId | number |
L’identificateur du groupe de vérifications dont fait partie cette vérification. |
|
Ordre de groupe
|
groupOrder | number |
Position de cette vérification dans un groupe de vérifications. Il détermine dans quel ordre les vérifications sont exécutées lorsqu’un groupe est déclenché à partir de l’API ou de CI/CD. |
|
ID d’exécution
|
runtimeId | string |
La version du runtime, c’est-à-dire l’ensemble fixe de dépendances d’exécution, utilisé pour exécuter cette vérification. |
|
alertChannelSubscriptions
|
alertChannelSubscriptions | CheckAlertChannelSubscriptionList | |
|
Vérifier le type
|
checkType | string |
Type de la vérification. |
|
Fréquence
|
frequency | integer |
Fréquence à laquelle la vérification doit s’exécuter en minutes. |
|
Décalage de fréquence
|
frequencyOffset | integer |
Décalage de fréquence. |
|
Vérifier la demande
|
request | CheckRequest |
Demande de vérification. |
|
Scénario
|
script | string |
Script. |
|
Vérifier la liste des variables d’environnement
|
environmentVariables | CheckEnvironmentVariableList |
Paires clé/valeur pour définir des variables d’environnement pendant l’exécution de la vérification. Celles-ci sont uniquement pertinentes pour les vérifications du navigateur. Utilisez des variables d’environnement globales dans la mesure du possible. |
|
ID d’extrait de code d’installation
|
setupSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase d’installation d’une vérification d’API. |
|
ID de l’extrait de code de destruction
|
tearDownSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase de destruction d’une vérification d’API. |
|
Script d’installation local
|
localSetupScript | string |
Élément valide de Node.js code à exécuter dans la phase d’installation. |
|
Script de destruction locale
|
localTearDownScript | string |
Élément valide de Node.js code à exécuter dans la phase de déblochage. |
|
Temps de réponse détérioré
|
degradedResponseTime | number |
Temps de réponse en millisecondes où une vérification doit être considérée comme détériorée. |
|
Temps de réponse maximal
|
maxResponseTime | number |
Temps de réponse en millisecondes où une vérification doit être considérée comme défaillante. |
|
alertChannels
|
alertChannels | CheckAlertChannels | |
|
Emplacements privés
|
privateLocations | privateLocations |
Tableau d’un ou plusieurs emplacements privés où exécuter la vérification. |
|
Créé à
|
created_at | date |
Quand il est créé à l’adresse. |
|
Mise à jour à
|
updated_at | date-time |
Lorsqu’il est mis à jour à l’adresse. |
CheckList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
Check |
Modèle 14
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
KeyValue |
Model15
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
KeyValue |
Model16
Détermine la demande que la vérification va s’exécuter.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
method
|
method | string | |
|
URL
|
url | string |
Adresse URL. |
|
Suivre les redirections
|
followRedirects | boolean |
Indique s’il faut suivre les redirections. |
|
Ignorer SSL
|
skipSSL | boolean |
Indique s’il faut ignorer SSL. |
|
Corps
|
body | string |
Le corps. |
|
Type de corps
|
bodyType | string |
Type de corps. |
|
headers
|
headers | Model14 | |
|
queryParameters
|
queryParameters | Model15 | |
|
Liste d’assertions
|
assertions | AssertionList |
Consultez la documentation principale sur les assertions pour des valeurs spécifiques telles que les expressions régulières et les descripteurs de chemin JSON que vous pouvez utiliser dans le champ de propriété. |
|
basicAuth
|
basicAuth | BasicAuth |
CheckAPI
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
Nom
|
name | string |
Nom de la vérification. |
|
Activated
|
activated | boolean |
Détermine si la vérification est en cours d’exécution ou non. |
|
Assourdi
|
muted | boolean |
Détermine si des notifications sont envoyées lorsqu’une vérification échoue et/ou récupère. |
|
Vérification double
|
doubleCheck | boolean |
La définition de cette valeur sur true déclenche une nouvelle tentative lorsqu’une vérification échoue à partir de la région défaillante et une autre région sélectionnée de manière aléatoire avant d’marquer la vérification comme ayant échoué. |
|
Doit échouer
|
shouldFail | boolean |
Permet d’inverser le comportement de l’échec d’une vérification. Permet de valider l’état d’erreur comme 404. |
|
Vérifier la liste des emplacements
|
locations | CheckLocationList |
Tableau d’un ou plusieurs emplacements de centre de données où exécuter cette vérification. |
|
Vérifier la liste des balises
|
tags | CheckTagList |
Balises pour l’organisation et le filtrage des vérifications. |
|
Vérifier les paramètres d’alerte
|
alertSettings | CheckAlertSettings |
Paramètres d’alerte. |
|
Utiliser les paramètres d’alerte globale
|
useGlobalAlertSettings | boolean |
Lorsque la valeur est true, le paramètre d’alerte au niveau du compte est utilisé, et non le paramètre d’alerte défini sur cette vérification. |
|
ID de groupe
|
groupId | number |
L’identificateur du groupe de vérifications dont fait partie cette vérification. |
|
Ordre de groupe
|
groupOrder | number |
Position de cette vérification dans un groupe de vérifications. Il détermine dans quel ordre les vérifications sont exécutées lorsqu’un groupe est déclenché à partir de l’API ou de CI/CD. |
|
ID d’exécution
|
runtimeId | string |
La version du runtime, c’est-à-dire l’ensemble fixe de dépendances d’exécution, utilisé pour exécuter cette vérification. |
|
alertChannelSubscriptions
|
alertChannelSubscriptions | CheckAlertChannelSubscriptionList | |
|
Vérifier la demande
|
request | Model16 |
Détermine la demande que la vérification va s’exécuter. |
|
Fréquence
|
frequency | integer |
Fréquence à laquelle la vérification doit s’exécuter en minutes. |
|
Décalage de fréquence
|
frequencyOffset | integer |
Utilisé pour définir des secondes pour les fréquences de vérification de moins de 1 minutes (uniquement pour les vérifications d’API) et la répartition des vérifications sur une plage de temps pour les fréquences de plus de 1 minute. Cela fonctionne comme suit : Les vérifications avec une fréquence de 0 peuvent avoir une fréquenceOffset de 10, 20 ou 30, ce qui signifie qu’elles s’exécutent toutes les 10, 20 ou 30 secondes. Les vérifications avec une fréquence inférieure et égale à 60 peuvent avoir une fréquenceOffset comprise entre 1 et une valeur maximale basée sur la formule Math.floor(frequency * 10), c’est-à-dire pour une vérification qui s’exécute toutes les 5 minutes, la fréquence maximaleOffset est de 50. Les vérifications avec une fréquence supérieure à 60 peuvent avoir un frequencyOffset compris entre 1 et une valeur maximale basée sur la formule Math.ceil(frequency / 60), c’est-à-dire pour une vérification qui s’exécute toutes les 720 minutes, la fréquence maximaleOffset est 12. |
|
ID de l’extrait de code de destruction
|
tearDownSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase de destruction d’une vérification d’API. |
|
ID d’extrait de code d’installation
|
setupSnippetId | number |
Référence d’identificateur à un extrait de code à utiliser dans la phase d’installation d’une vérification d’API. |
|
Script d’installation local
|
localSetupScript | string |
Élément valide de Node.js code à exécuter dans la phase d’installation. |
|
Script de destruction locale
|
localTearDownScript | string |
Élément valide de Node.js code à exécuter dans la phase de déblochage. |
|
Temps de réponse détérioré
|
degradedResponseTime | number |
Temps de réponse en millisecondes où une vérification doit être considérée comme détériorée. |
|
Temps de réponse maximal
|
maxResponseTime | number |
Temps de réponse en millisecondes où une vérification doit être considérée comme défaillante. |
|
Emplacements privés
|
privateLocations | privateLocations |
Tableau d’un ou plusieurs emplacements privés où exécuter la vérification. |
|
Vérifier le type
|
checkType | string |
Type de vérification. |
|
alertChannels
|
alertChannels | CheckAlertChannels | |
|
Créé à
|
created_at | date |
Quand il est créé à l’adresse. |
|
Mise à jour à
|
updated_at | date-time |
Lorsqu’il est mis à jour à l’adresse. |
CheckBrowser
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
Nom
|
name | string |
Nom de la vérification. |
|
Activated
|
activated | boolean |
Détermine si la vérification est en cours d’exécution ou non. |
|
Assourdi
|
muted | boolean |
Détermine si des notifications sont envoyées lorsqu’une vérification échoue et/ou récupère. |
|
Vérification double
|
doubleCheck | boolean |
La définition de cette valeur sur true déclenche une nouvelle tentative lorsqu’une vérification échoue à partir de la région défaillante et une autre région sélectionnée de manière aléatoire avant d’marquer la vérification comme ayant échoué. |
|
Doit échouer
|
shouldFail | boolean |
Permet d’inverser le comportement de l’échec d’une vérification. Permet de valider l’état d’erreur comme 404. |
|
Vérifier la liste des emplacements
|
locations | CheckLocationList |
Tableau d’un ou plusieurs emplacements de centre de données où exécuter cette vérification. |
|
Vérifier la liste des balises
|
tags | CheckTagList |
Balises pour l’organisation et le filtrage des vérifications. |
|
Vérifier les paramètres d’alerte
|
alertSettings | CheckAlertSettings |
Paramètres d’alerte. |
|
Utiliser les paramètres d’alerte globale
|
useGlobalAlertSettings | boolean |
Lorsque la valeur est true, le paramètre d’alerte au niveau du compte est utilisé, et non le paramètre d’alerte défini sur cette vérification. |
|
ID de groupe
|
groupId | number |
L’identificateur du groupe de vérifications dont fait partie cette vérification. |
|
Ordre de groupe
|
groupOrder | number |
Position de cette vérification dans un groupe de vérifications. Il détermine dans quel ordre les vérifications sont exécutées lorsqu’un groupe est déclenché à partir de l’API ou de CI/CD. |
|
ID d’exécution
|
runtimeId | string |
La version du runtime, c’est-à-dire l’ensemble fixe de dépendances d’exécution, utilisé pour exécuter cette vérification. |
|
alertChannelSubscriptions
|
alertChannelSubscriptions | CheckAlertChannelSubscriptionList | |
|
Vérifier le type
|
checkType | string |
Type de vérification. |
|
Fréquence
|
frequency | integer |
Fréquence à laquelle la vérification doit s’exécuter en minutes. |
|
Scénario
|
script | string |
Élément valide de Node.js code javascript décrivant une interaction de navigateur avec les frameworks Puppeteer ou Playwright. |
|
Emplacements privés
|
privateLocations | privateLocations |
Tableau d’un ou plusieurs emplacements privés où exécuter la vérification. |
|
alertChannels
|
alertChannels | CheckAlertChannels | |
|
Créé à
|
created_at | date |
Quand il est créé à l’adresse. |
|
Mise à jour à
|
updated_at | date-time |
Lorsqu’il est mis à jour à l’adresse. |
DashboardTagList
Liste d’une ou de plusieurs balises qui filtrent les contrôles à afficher sur le tableau de bord.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
string |
Dashboard
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Domaine personnalisé
|
customDomain | string |
Un domaine d’utilisateur personnalisé, par exemple, status.example.com. Consultez les documents sur la mise à jour de votre utilisation DNS et SSL. |
|
URL personnalisée
|
customUrl | string |
Nom de sous-domaine sous checklyhq.com. Doit être unique pour tous les utilisateurs. |
|
Logo
|
logo | string |
URL pointant vers un fichier image. |
|
Favicon
|
favicon | string |
URL pointant vers un fichier image utilisé comme favicon de tableau de bord. |
|
Lien
|
link | string |
Lien d’URL à rediriger lorsque le logo du tableau de bord est cliqué dessus. |
|
Header
|
header | string |
Élément de texte affiché en haut de votre tableau de bord. |
|
Descriptif
|
description | string |
Élément de texte affiché sous l’en-tête ou le titre de votre tableau de bord. |
|
Largeur
|
width | string |
Détermine s’il faut utiliser l’écran plein ou le focus dans le centre. |
|
Taux d’actualisation
|
refreshRate | number |
Fréquence d’actualisation du tableau de bord en secondes. |
|
Paginer
|
paginate | boolean |
Détermine la pagination est activée ou désactivée. |
|
Taux de pagination
|
paginationRate | number |
Fréquence à laquelle déclencher la pagination en secondes. |
|
Vérifications par page
|
checksPerPage | number |
Nombre de vérifications affichées par page. |
|
Utiliser et opérateur
|
useTagsAndOperator | boolean |
Quand utiliser l’opérateur AND pour la recherche de balises. |
|
Masquer les étiquettes
|
hideTags | boolean |
Affichez ou masquez les balises dans le tableau de bord. |
|
Liste des balises du tableau de bord
|
tags | DashboardTagList |
Liste d’une ou de plusieurs balises qui filtrent les contrôles à afficher sur le tableau de bord. |
|
ID de tableau de bord
|
dashboardId | string |
Identificateur du tableau de bord. |
DashboardsList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
Dashboard |
Emplacement
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Région
|
region | string |
Identificateur unique de cet emplacement. |
|
Nom
|
name | string |
Nom convivial de cet emplacement. |
LocationList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
Location |
MaintenanceWindowTagList
Les noms de la fenêtre de maintenance des contrôles et des groupes doivent s’appliquer.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
string |
MaintenanceWindow
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | number |
Identificateur de la fenêtre de maintenance. |
|
Nom
|
name | string |
Nom de la fenêtre de maintenance. |
|
Liste des balises de fenêtre de maintenance
|
tags | MaintenanceWindowTagList |
Les noms de la fenêtre de maintenance des contrôles et des groupes doivent s’appliquer. |
|
Commence à
|
startsAt | date |
Date de début de la fenêtre de maintenance. |
|
Se termine à
|
endsAt | date |
Date de fin de la fenêtre de maintenance. |
|
Intervalle de répétition
|
repeatInterval | number |
Intervalle de répétition de la fenêtre de maintenance à partir de la première occurrence. |
|
Unité de répétition
|
repeatUnit | string |
Stratégie de répétition de la fenêtre de maintenance. |
|
Répéter les extrémités à
|
repeatEndsAt | date |
Date de fin où la fenêtre de maintenance doit cesser de se répéter. |
|
Créé à
|
created_at | date |
Date de création de la fenêtre de maintenance. |
|
Mise à jour à
|
updated_at | date |
Date de la dernière mise à jour de la fenêtre de maintenance. |
MaintenanceWindowList
Liste des fenêtres de maintenance.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
MaintenanceWindow |
CheckAssignment
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | guid |
Identificateur. |
|
Vérifier l’ID
|
checkId | guid |
Identificateur de la vérification. |
|
ID d’emplacement privé
|
privateLocationId | guid |
Identificateur de l’emplacement privé affecté. |
checkAssignments
Vérifiez que cet emplacement privé a été attribué.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
CheckAssignment |
GroupAssignment
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | guid |
Identificateur. |
|
ID de groupe
|
groupId | number |
Identificateur du groupe. |
|
ID d’emplacement privé
|
privateLocationId | guid |
Identificateur de l’emplacement privé affecté. |
groupAssignments
Groupe auquel cet emplacement privé a été attribué.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
GroupAssignment |
privateLocationKeys
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | guid |
Identificateur. |
|
Clé brute
|
rawKey | string |
Clé brute. |
|
Clé masquée
|
maskedKey | string |
Valeur de clé masquée. |
|
Créé à
|
created_at | date |
Quand il est créé à l’adresse. |
|
Mise à jour à
|
updated_at | date |
Lorsqu’il est mis à jour à l’adresse. |
clés
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
privateLocationKeys |
privatelocationschema
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | guid |
Identificateur. |
|
Nom
|
name | string |
Nom attribué à l’emplacement privé. |
|
Nom slug
|
slugName | string |
Nom de la slug valide. |
|
Icône
|
icon | string |
Icône d’emplacement privé. |
|
Créé à
|
created_at | date |
Quand il est créé à l’adresse. |
|
Mise à jour à
|
updated_at | date |
Lorsqu’il est mis à jour à l’adresse. |
|
Vérifier les affectations
|
checkAssignments | checkAssignments |
Vérifiez que cet emplacement privé a été attribué. |
|
Affectations de groupe
|
groupAssignments | groupAssignments |
Groupe auquel cet emplacement privé a été attribué. |
|
clés
|
keys | keys | |
|
Dernière vue
|
lastSeen | date |
Date de la dernière vue. |
|
Nombre d’agents
|
agentCount | number |
Nombre d’agents. |
privateLocationsListSchema
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
privatelocationschema |
commonPrivateLocationSchemaResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | guid |
Identificateur. |
|
Nom
|
name | string |
Nom attribué à l’emplacement privé. |
|
Nom slug
|
slugName | string |
Nom de la slug valide. |
|
Icône
|
icon | string |
Icône d’emplacement privé. |
|
Créé à
|
created_at | date |
Quand il est créé à l’adresse. |
|
Mise à jour à
|
updated_at | date |
Lorsqu’il est mis à jour à l’adresse. |
|
Vérifier les affectations
|
checkAssignments | checkAssignments |
Vérifiez que cet emplacement privé a été attribué. |
|
Affectations de groupe
|
groupAssignments | groupAssignments |
Groupe auquel cet emplacement privé a été attribué. |
|
clés
|
keys | keys |
Timestamps
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Timestamp
|
date-time |
Horodatage. |
queueSize
Taille de la file d’attente.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
number |
oldestScheduledCheckRun
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
number |
privateLocationsMetricsHistoryResponseSchema
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Timestamps
|
timestamps | timestamps | |
|
Taille de la file d’attente
|
queueSize | queueSize |
Taille de la file d’attente. |
|
oldestScheduledCheckRun
|
oldestScheduledCheckRun | oldestScheduledCheckRun |
ReportingTagList
Vérifiez les balises.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
string |
ReportingAggregate
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Taux de réussite
|
successRatio | number |
Taux de réussite de l’enregistrement sur la plage de dates sélectionnée. Le pourcentage est sous forme décimale. |
|
Moyen
|
avg | number |
Temps de réponse moyen de l’enregistrement de la plage de dates sélectionnée en millisecondes. |
|
P95
|
p95 | number |
Temps de réponse P95 de la plage de dates sélectionnée en millisecondes. |
|
P99
|
p99 | number |
Heure de réponse P99 de la plage de dates sélectionnée en millisecondes. |
Rapports
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
name | string |
Vérifiez le nom. |
|
Vérifier l’ID
|
checkId | string |
Vérifiez l’ID. |
|
Vérifier le type
|
checkType | string |
Type de vérification. |
|
Désactivé
|
deactivated | boolean |
Vérifiez la désactivation. |
|
Liste des balises de création de rapports
|
tags | ReportingTagList |
Vérifiez les balises. |
|
aggregate
|
aggregate | ReportingAggregate |
ReportingList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
Reporting |
Temps d'exécution
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
name | string |
Nom unique de ce runtime. |
|
Étape
|
stage | string |
Phase de vie actuelle d’un runtime. |
|
Fin de vie du runtime
|
runtimeEndOfLife | string |
Date à laquelle un runtime sera supprimé de notre plateforme. |
|
Par défaut
|
default | boolean |
Indique s’il s’agit du runtime par défaut actuel fourni par Checkly. |
|
Descriptif
|
description | string |
Brève description lisible par l’homme des principales mises à jour dans ce runtime. |
|
Chaîne
|
dependencies.string | string |
Chaîne. |
RuntimeList
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
Runtime |
Extrait
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | number |
Identificateur. |
|
Nom
|
name | string |
Nom de l’extrait de code. |
|
Scénario
|
script | string |
Votre code Node.js qui interagit avec le cycle de vie de vérification de l’API ou fonctionne comme un élément partiel pour les vérifications de navigateur. |
|
Créé à
|
created_at | date-time |
Quand il est créé à l’adresse. |
|
Mise à jour à
|
updated_at | date-time |
Lorsqu’il est mis à jour à l’adresse. |
Extrait de code
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
Snippet |
CheckGroupTrigger
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | number |
Identificateur. |
|
Jeton
|
token | string |
Jeton. |
|
Créé à
|
created_at | date |
Quand il est créé à l’adresse. |
|
Appelé At
|
called_at | date |
Quand on l’appelle. |
|
Mise à jour à
|
updated_at | date |
Lorsqu’il est mis à jour à l’adresse. |
|
ID de groupe
|
groupId | number |
Identificateur de groupe. |
CheckTrigger
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | number |
Identificateur. |
|
Jeton
|
token | string |
Jeton. |
|
Créé à
|
created_at | date |
Quand il est créé à l’adresse. |
|
Appelé At
|
called_at | date |
Quand on l’appelle. |
|
Mise à jour à
|
updated_at | date |
Lorsqu’il est mis à jour à l’adresse. |
|
Vérifier l’ID
|
checkId | string |
Identificateur de vérification. |
objet
Il s’agit du type 'object'.
ficelle
Il s’agit du type de données de base « string ».