Moniteurs

Notes
Niveau expert
La clé API doit être envoyée comme jeton Bearer dans l'en-tête Authorization de la requête. Obtenir votre clé API.
Liste

Point de terminaison API:

GET 
https://up.aubin.dev/api/v1/monitors

Exemple de requête: 

curl --location --request GET 'https://up.aubin.dev/api/v1/monitors' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
search
facultatif string
La requête de recherche.
search_by
facultatif string
Rechercher par. Les valeurs possibles sont : name pour Nom, url pour URL. Par défaut : name.
status_page_id
facultatif integer
ID de page de statut.
sort_by
facultatif string
Trier par. Les valeurs possibles sont : id pour Date de création, name pour Nom, url pour URL. Par défaut : id.
sort
facultatif string
Trier. Les valeurs possibles sont : desc pour Décroissant, asc pour Croissant. Par défaut : desc.
per_page
facultatif integer
Résultats par page. Les valeurs possibles sont : 10, 25, 50, 100. Par défaut : 25.
Afficher

Point de terminaison API:

GET 
https://up.aubin.dev/api/v1/monitors/{id}

Exemple de requête: 

curl --location --request GET 'https://up.aubin.dev/api/v1/monitors/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Stocker

Point de terminaison API:

POST 
https://up.aubin.dev/api/v1/monitors

Exemple de requête: 

curl --location --request POST 'https://up.aubin.dev/api/v1/monitors' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'url={url}' \
--data-urlencode 'interval={interval}'
Paramètre
Type
Description
name
requis string
Nom.
url
requis string
URL.
interval
requis integer
Intervalle. Les valeurs possibles sont : 60, 180, 300, 600, 900, 1800, 3600.
alert_condition
facultatif string
Condition d'alerte. Les valeurs possibles sont : url_unavailable pour L'URL devient indisponible, url_text pour La réponse de l'URL contient le texte, url_no_text pour La réponse de l'URL ne contient pas le texte. Par défaut : url_unavailable.
alert_text_lookup
facultatif string
Texte à rechercher pour déclencher des alertes. Ne fonctionne que si le champ alert_condition est défini sur url_text, url_no_text.
request_method
facultatif string
Méthode de requête. Les valeurs possibles sont : GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS. Par défaut : GET.
request_headers[index][key]
facultatif string
Nom de l'en-tête de requête.
request_headers[index][value]
facultatif string
Valeur de l'en-tête de requête.
request_auth_username
facultatif string
Username for Basic HTTP request authentication.
request_auth_password
facultatif string
Password for Basic HTTP request authentication.
cache_buster
facultatif integer
Anti-cache. Les valeurs possibles sont : 0 pour Désactivé, 1 pour Activé. Par défaut : 0.
ssl_alert_days
facultatif integer
Le nombre de jours avant l'expiration du certificat SSL pour recevoir une alerte. Les valeurs possibles sont : 0, 1, 2, 3, 7, 14, 30, 60.
domain_alert_days
facultatif integer
Le nombre de jours avant l'expiration du nom de domaine pour recevoir une alerte. Les valeurs possibles sont : 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
facultatif string
Date de début de maintenance au format Y-m-dTH:i:s.
maintenance_end_at
facultatif string
Date de fin de maintenance au format Y-m-dTH:i:s.
alerts[index][key]
facultatif string
Canaux d'alerte. Les valeurs possibles sont : email pour Email, webhook pour Webhook, slack pour Slack, teams pour Microsoft Teams, discord pour Discord, flock pour Flock, telegram pour Telegram, sms pour SMS.
alerts[index][value]
facultatif string
Valeur de l'alerte.
Mettre à jour

Point de terminaison API:

PUT PATCH 
https://up.aubin.dev/api/v1/monitors/{id}

Exemple de requête: 

curl --location --request PUT 'https://up.aubin.dev/api/v1/monitors/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
name
facultatif string
Nom.
url
facultatif string
URL.
interval
facultatif integer
Intervalle. Les valeurs possibles sont : 60, 180, 300, 600, 900, 1800, 3600.
alert_condition
facultatif string
Condition d'alerte. Les valeurs possibles sont : url_unavailable pour L'URL devient indisponible, url_text pour La réponse de l'URL contient le texte, url_no_text pour La réponse de l'URL ne contient pas le texte. Par défaut : url_unavailable.
alert_text_lookup
facultatif string
Texte à rechercher pour déclencher des alertes. Ne fonctionne que si le champ alert_condition est défini sur url_text, url_no_text.
request_method
facultatif string
Méthode de requête. Les valeurs possibles sont : GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS. Par défaut : GET.
request_headers[index][key]
facultatif string
Nom de l'en-tête de requête.
request_headers[index][value]
facultatif string
Valeur de l'en-tête de requête.
request_auth_username
facultatif string
Username for Basic HTTP request authentication.
request_auth_password
facultatif string
Password for Basic HTTP request authentication.
cache_buster
facultatif integer
Anti-cache. Les valeurs possibles sont : 0 pour Désactivé, 1 pour Activé.
ssl_alert_days
facultatif integer
Le nombre de jours avant l'expiration du certificat SSL pour recevoir une alerte. Les valeurs possibles sont : 0, 1, 2, 3, 7, 14, 30, 60.
domain_alert_days
facultatif integer
Le nombre de jours avant l'expiration du nom de domaine pour recevoir une alerte. Les valeurs possibles sont : 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
facultatif string
Date de début de maintenance au format Y-m-dTH:i:s.
maintenance_end_at
facultatif string
Date de fin de maintenance au format Y-m-dTH:i:s.
alerts[index][key]
facultatif string
Canaux d'alerte. Les valeurs possibles sont : email pour Email, webhook pour Webhook, slack pour Slack, teams pour Microsoft Teams, discord pour Discord, flock pour Flock, telegram pour Telegram, sms pour SMS.
alerts[index][value]
facultatif string
Valeur de l'alerte.
pause
facultatif boolean
Mettre en pause.
Supprimer

Point de terminaison API:

DELETE 
https://up.aubin.dev/api/v1/monitors/{id}

Exemple de requête: 

curl --location --request DELETE 'https://up.aubin.dev/api/v1/monitors/{id}' \
--header 'Authorization: Bearer {api_key}'