Monitore
GET https://www.serverpruefung.de/api/monitors/
curl --request GET \
--url 'https://www.serverpruefung.de/api/monitors/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://www.serverpruefung.de/api/monitors/' \
--header 'Authorization: Bearer {api_key}' \
| Parameter | Details | Beschreibung |
|---|---|---|
| page | Optional Ganze Zahl | Die Seitenzahl, von der Sie Ergebnisse erhalten möchten. Standardmäßig 1. |
| results_per_page | Optional Ganze Zahl | Wie viele Ergebnisse Sie pro Seite wünschen. Zulässige Werte sind: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Der Standardwert ist 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://www.serverpruefung.de/api/monitors?&page=1",
"last": "https://www.serverpruefung.de/api/monitors?&page=1",
"next": null,
"prev": null,
"self": "https://www.serverpruefung.de/api/monitors?&page=1"
}
}
GET https://www.serverpruefung.de/api/monitors/{monitor_id}
curl --request GET \
--url 'https://www.serverpruefung.de/api/monitors/{monitor_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://www.serverpruefung.de/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"
}
}
POST https://www.serverpruefung.de/api/monitors
| Parameter | Details | Beschreibung |
|---|---|---|
| name | Erforderlich Schnur | - |
| target | Erforderlich Schnur | - |
| port | Optional Schnur | - |
| type | Optional Schnur | Erlaubte Werte: website, ping, port |
| project_id | Optional Ganze Zahl | - |
| ping_servers_ids | Optional Array | Erlaubte Werte: 1, 2 |
| check_interval_seconds | Optional Ganze Zahl | Erlaubte Werte: 60, 180, 300, 600, 1800, 3600, 21600, 43200, 86400 (Sekunden) |
| timeout_seconds | Optional Ganze Zahl | Erlaubte Werte: 1, 2, 3, 5, 10, 25 (Sekunden) |
| ping_ipv | Optional Schnur |
Verfügbar, wenn: type = ping Erlaubte Werte: ipv4, ipv6 |
| request_method | Optional Schnur | Erlaubte Werte: HEAD, GET, POST, PUT, PATCH |
| request_body | Optional Schnur | - |
| request_basic_auth_username | Optional Schnur | - |
| request_basic_auth_password | Optional Schnur | - |
| request_header_name | Optional Array | - |
| request_header_value | Optional Array | - |
| response_status_code | Optional Ganze Zahl | - |
| response_body | Optional Schnur | - |
| response_header_name | Optional Schnur | - |
| response_header_value | Optional Schnur | - |
| is_ok_notifications | Optional Array | Benachrichtigungs-Handler-IDs |
| email_reports_is_enabled | Optional Boolean | - |
| cache_buster_is_enabled | Optional Boolean | - |
| is_enabled | Optional Boolean | - |
curl --request POST \
--url 'https://www.serverpruefung.de/api/monitors' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'target=https://example.com/' \
--url 'https://www.serverpruefung.de/api/monitors' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'target=https://example.com/' \
{
"data": {
"id": 1
}
}
POST https://www.serverpruefung.de/api/monitors/{monitor_id}
| Parameter | Details | Beschreibung |
|---|---|---|
| name | Optional Schnur | - |
| target | Optional Schnur | - |
| port | Optional Schnur | - |
| type | Optional Schnur | Erlaubte Werte: website, ping, port |
| project_id | Optional Ganze Zahl | - |
| ping_servers_ids | Optional Array | Erlaubte Werte: 1, 2 |
| check_interval_seconds | Optional Ganze Zahl | Erlaubte Werte: 60, 180, 300, 600, 1800, 3600, 21600, 43200, 86400 (Sekunden) |
| timeout_seconds | Optional Ganze Zahl | Erlaubte Werte: 1, 2, 3, 5, 10, 25 (Sekunden) |
| ping_ipv | Optional Schnur |
Verfügbar, wenn: type = ping Erlaubte Werte: ipv4, ipv6 |
| request_method | Optional Schnur | Erlaubte Werte: HEAD, GET, POST, PUT, PATCH |
| request_body | Optional Schnur | - |
| request_basic_auth_username | Optional Schnur | - |
| request_basic_auth_password | Optional Schnur | - |
| request_header_name | Optional Array | - |
| request_header_value | Optional Array | - |
| response_status_code | Optional Ganze Zahl | - |
| response_body | Optional Schnur | - |
| response_header_name | Optional Schnur | - |
| response_header_value | Optional Schnur | - |
| is_ok_notifications | Optional Array | Benachrichtigungs-Handler-IDs |
| email_reports_is_enabled | Optional Boolean | - |
| cache_buster_is_enabled | Optional Boolean | - |
| is_enabled | Optional Boolean | - |
curl --request POST \
--url 'https://www.serverpruefung.de/api/monitors/{monitor_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--url 'https://www.serverpruefung.de/api/monitors/{monitor_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
{
"data": {
"id": 1
}
}
DELETE https://www.serverpruefung.de/api/monitors/{monitor_id}
curl --request DELETE \
--url 'https://www.serverpruefung.de/api/monitors/{monitor_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://www.serverpruefung.de/api/monitors/{monitor_id}' \
--header 'Authorization: Bearer {api_key}' \