Moniteurs

Récupérer tout

GET https://uptimedns.com/api/monitors/
curl --request GET \
--url 'https://uptimedns.com/api/monitors/' \
--header 'Authorization: Bearer {api_key}' \
Paramètres Détails Description
page Facultatif Entier Le numéro de page à partir duquel vous souhaitez obtenir des résultats. Par défaut à 1
results_per_page Facultatif Entier Combien de résultats voulez-vous par page. Les valeurs autorisées sont : 10 , 25 , 50 , 100 , 250 , 500 , 1000. Par défaut à 25.
{ "data": [ { "id": 1, "project_id": 0, "name": "Example", "type": "website", "target": "https://example.com/", "port": 0, "settings": { "check_interval_seconds": 3600, "timeout_seconds": 1, "request_method": "GET", "request_body": "", "request_basic_auth_username": "", "request_basic_auth_password": "", "request_headers": [], "response_status_code": 200, "response_body": "", "response_headers": [] }, "ping_servers_ids": [1], "is_ok": 1, "uptime": 95.5, "downtime": 4.5, "average_response_time": 500, "total_checks": 500, "total_ok_checks": 450, "total_not_ok_checks": 50, "last_check_datetime": "2021-03-25 08:27:07", "notifications": { "email_is_enabled": 0, "webhook":"", "slack":"", "twilio":"" }, "is_enabled": false, "datetime": "2021-02-12 21:54:29" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://uptimedns.com/api/monitors?&page=1", "last": "https://uptimedns.com/api/monitors?&page=1", "next": null, "prev": null, "self": "https://uptimedns.com/api/monitors?&page=1" } }

Récupérer un

GET https://uptimedns.com/api/monitors/{monitor_id}
curl --request GET \
--url 'https://uptimedns.com/api/monitors/{monitor_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "project_id": 0, "name": "Example", "type": "website", "target": "https://example.com/", "port": 0, "settings": { "check_interval_seconds": 3600, "timeout_seconds": 1, "request_method": "GET", "request_body": "", "request_basic_auth_username": "", "request_basic_auth_password": "", "request_headers": [], "response_status_code": 200, "response_body": "", "response_headers": [] }, "ping_servers_ids": [1], "is_ok": 1, "uptime": 95.5, "downtime": 4.5, "average_response_time": 500, "total_checks": 500, "total_ok_checks": 450, "total_not_ok_checks": 50, "last_check_datetime": "2021-03-25 08:27:07", "notifications": { "email_is_enabled": 0, "webhook":"", "slack":"", "twilio":"" }, "is_enabled": false, "datetime": "2021-02-12 21:54:29" } }

Créer

POST https://uptimedns.com/api/monitors
Paramètres Détails Description
name Requis Chaîne -
target Requis Chaîne -
port Facultatif Chaîne -
type Facultatif Chaîne Valeurs autorisées : website, ping, port
project_id Facultatif Entier -
ping_servers_ids Facultatif Array Valeurs autorisées : 1, 2, 3, 4
check_interval_seconds Facultatif Entier Valeurs autorisées : 60, 180, 300, 600, 1800, 3600, 21600, 43200, 86400 (secondes)
timeout_seconds Facultatif Entier Valeurs autorisées : 1, 2, 3, 5, 10, 25 (secondes)
ping_ipv Facultatif Chaîne Disponible quand : type = ping
Valeurs autorisées : ipv4, ipv6
request_method Facultatif Chaîne Valeurs autorisées : HEAD, GET, POST, PUT, PATCH
request_body Facultatif Chaîne -
request_basic_auth_username Facultatif Chaîne -
request_basic_auth_password Facultatif Chaîne -
request_header_name Facultatif Array -
request_header_value Facultatif Array -
response_status_code Facultatif Entier -
response_body Facultatif Chaîne -
response_header_name Facultatif Chaîne -
response_header_value Facultatif Chaîne -
is_ok_notifications Facultatif Array Identifiants des gestionnaires de notification
email_reports_is_enabled Facultatif Booléen -
cache_buster_is_enabled Facultatif Booléen -
verify_ssl_is_enabled Facultatif Booléen -
is_enabled Facultatif Booléen -
curl --request POST \
--url 'https://uptimedns.com/api/monitors' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'target=https://example.com/' \
{ "data": { "id": 1 } }

Mettre à jour

POST https://uptimedns.com/api/monitors/{monitor_id}
Paramètres Détails Description
name Facultatif Chaîne -
target Facultatif Chaîne -
port Facultatif Chaîne -
type Facultatif Chaîne Valeurs autorisées : website, ping, port
project_id Facultatif Entier -
ping_servers_ids Facultatif Array Valeurs autorisées : 1, 2, 3, 4
check_interval_seconds Facultatif Entier Valeurs autorisées : 60, 180, 300, 600, 1800, 3600, 21600, 43200, 86400 (secondes)
timeout_seconds Facultatif Entier Valeurs autorisées : 1, 2, 3, 5, 10, 25 (secondes)
ping_ipv Facultatif Chaîne Disponible quand : type = ping
Valeurs autorisées : ipv4, ipv6
request_method Facultatif Chaîne Valeurs autorisées : HEAD, GET, POST, PUT, PATCH
request_body Facultatif Chaîne -
request_basic_auth_username Facultatif Chaîne -
request_basic_auth_password Facultatif Chaîne -
request_header_name Facultatif Array -
request_header_value Facultatif Array -
response_status_code Facultatif Entier -
response_body Facultatif Chaîne -
response_header_name Facultatif Chaîne -
response_header_value Facultatif Chaîne -
is_ok_notifications Facultatif Array Identifiants des gestionnaires de notification
email_reports_is_enabled Facultatif Booléen -
cache_buster_is_enabled Facultatif Booléen -
verify_ssl_is_enabled Facultatif Booléen -
is_enabled Facultatif Booléen -
curl --request POST \
--url 'https://uptimedns.com/api/monitors/{monitor_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
{ "data": { "id": 1 } }

Supprimer

DELETE https://uptimedns.com/api/monitors/{monitor_id}
curl --request DELETE \
--url 'https://uptimedns.com/api/monitors/{monitor_id}' \
--header 'Authorization: Bearer {api_key}' \