ICMP Monitor erstellen
Erstellt einen neuen ICMP Monitor.
POST /api/icmp-monitors
Authentifizierung
Erfordert eine gültige Session.
- Header:
Authorization: Bearer <token>
Request Body
{
"customerId": "6764e84f-f02a-43e6-a46d-cecaec556723",
"name": "Ping Gateway",
"hostname": "claas.sh",
"status": "active",
"checkInterval": 5,
"timeoutSeconds": 10,
"icmpConfig": {
"packetSize": 56,
"count": 4
}
}Felder
customerId(number | string, required)- Akzeptiert die interne numerische Kunden-ID oder die Customer-
publicId-UUID.
- Akzeptiert die interne numerische Kunden-ID oder die Customer-
name(string, required)hostname(string, required)- Muss nur Hostname oder IP sein (kein Protokoll wie
https://, kein Pfad wie/ping).
- Muss nur Hostname oder IP sein (kein Protokoll wie
status(string, optional)- Erlaubt:
active,maintenance,disabled,paused,inactive - Hinweis:
paused/inactivewerden zudisablednormalisiert.
- Erlaubt:
checkInterval(number, optional)timeoutSeconds(number, optional)icmpConfig(object, optional)- Wird als
configJSON am Monitor gespeichert.
- Wird als
icmpConfig (vom Worker unterstützte Keys)
packetSize(number)- Default:
56
- Default:
count(number)- Default:
3
- Default:
Duplikate
Hat dieser Kunde schon einen Monitor mit derselbe hostname (Gross- und Kleinschreibung und ein Punkt am Ende zählen nicht), wird die Anfrage mit 409 und data.code monitorAlreadyExists abgewiesen. data.existingId und data.existingPublicId nennen den vorhandenen Monitor. Mit "allowDuplicate": true wird der zweite Monitor trotzdem angelegt (zum Beispiel mit anderem Intervall oder anderen Alarmwegen).
allowDuplicate(boolean, optional, Standardfalse): Monitor auch als Duplikat anlegen. Wird nicht gespeichert.
{
"statusCode": 409,
"statusMessage": "A monitor for this target already exists for this customer. Send allowDuplicate: true to create it anyway.",
"data": { "code": "monitorAlreadyExists", "existingId": 300, "existingPublicId": "44444444-4444-4444-8444-444444444444" }
}Grenze je Ziel-Host
Eine Organisation kann höchstens 100 Monitore auf denselben Ziel-Host haben, gezählt über alle Monitortypen zusammen (Websites mit HTTP, Keyword, DNS-Website und Playwright mit echter URL, dazu TCP, ICMP, DNS, SSH, SMTP, FTP und IMAP/POP). Die Grenze schützt davor, dass die Checkflotte als Lastgenerator gegen fremde Hosts missbraucht wird. Verglichen wird der exakte Hostname: Gross- und Kleinschreibung, Port, Pfad und ein Punkt am Ende zählen nicht, www.example.com und example.com sind aber verschiedene Hosts. Ist die Grenze erreicht, wird die Anfrage mit 403 und data.code targetHostMonitorLimitReached abgewiesen. data.host nennt den normalisierten Host, data.limit die Grenze. "allowDuplicate": true hebt die Grenze nicht auf. Dieselbe Prüfung läuft, wenn ein PATCH den hostname ändert. Ein PATCH ohne Hostwechsel geht immer, vorhandene Monitore über der Grenze bleiben bestehen. Brauchst du eine höhere Grenze, wende dich an den Support. Unabhängig von deiner Organisation dürfen über alle Uptimeify-Kunden hinweg höchstens 300 Monitore auf denselben Host zeigen. Darüber wird die Anfrage mit 403 und data.code targetHostPlatformLimitReached abgewiesen; data.host und data.limit sind wie oben gesetzt, die Meldung verrät nicht, wie viele Monitore andere Organisationen haben.
{
"statusCode": 403,
"statusMessage": "Target host monitor limit reached: your organization already has 100 monitors for example.com (maximum 100 per host). Remove monitors for this host or contact support to raise the limit.",
"data": { "code": "targetHostMonitorLimitReached", "host": "example.com", "limit": 100 }
}cURL
curl -X POST "https://YOUR_DOMAIN/api/icmp-monitors" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"customerId": "6764e84f-f02a-43e6-a46d-cecaec556723",
"name": "Ping Gateway",
"hostname": "claas.sh",
"status": "active",
"checkInterval": 5,
"timeoutSeconds": 10,
"icmpConfig": { "packetSize": 56, "count": 4 }
}'Response
{
"id": 123,
"organizationId": 1,
"customerId": 2,
"name": "Ping Gateway",
"hostname": "claas.sh",
"port": null,
"status": "active",
"checkInterval": 5,
"timeoutSeconds": 10,
"allowedCheckCountryCodes": null,
"notificationPhoneNumber": null,
"notificationEmail": null,
"lastCheckedAt": null,
"createdAt": "2026-02-26T12:00:00.000Z",
"updatedAt": "2026-02-26T12:00:00.000Z",
"config": {
"packetSize": 56,
"count": 4
},
"icmpConfig": {
"packetSize": 56,
"count": 4
}
}Fehler
400 Invalid Customer identifier400Ungültiger Hostname oder ungültiger Request Body401Unauthorized403Forbidden (z. B.readonlyoder global supporter)404Kunde nicht gefunden403targetHostMonitorLimitReached: die Organisation hat schon 100 Monitore auf diesen Ziel-Host (siehe Grenze je Ziel-Host);allowDuplicate: truehebt die Grenze nicht auf403targetHostPlatformLimitReached: auf den Host zeigen über alle Uptimeify-Kunden schon 300 Monitore (siehe Grenze je Ziel-Host)409monitorAlreadyExists: dieser Kunde hat schon so einen Monitor (siehe Duplikate);allowDuplicate: truelegt ihn trotzdem an