Skip to Content
Uptimeify Docs

FTP Monitor erstellen

Erstellt einen neuen FTP Monitor.

POST /api/ftp-monitors

Authentifizierung

Dieser Endpoint benötigt ein API-Token:

Authorization: Bearer <token>

Request Body

  • customerId (required, number | string): interne numerische Kunden-ID oder Customer-publicId-UUID
  • name (required, string)
  • hostname (required, string): Muss ein Hostname sein (kein Protokoll, kein Pfad).
  • port (optional, number | null): Wenn weggelassen/null, nutzt der Worker einen Default-Port.
  • status (optional): active, maintenance, disabled (akzeptiert auch inactive und normalisiert zu disabled)
  • checkInterval (optional, number): Minuten (min: 1, max: 60)
  • timeoutSeconds (optional, number): Sekunden (min: 1, max: 60)
  • checkMode (optional, string): protocol | tcp. Standard: protocol.
    • Im Modus tcp führt der Monitor nur eine reine TCP-Port-Erreichbarkeitsprüfung durch: ftpConfig ist nicht erforderlich und wird nicht gespeichert. Im Modus protocol läuft die vollständige FTP-Login-Prüfung (bisheriges Verhalten).
  • ftpConfig (optional, object): FTP-Verbindungsoptionen (als JSON gespeichert)
    • Erforderlich (user + password), außer checkMode ist tcp.

ftpConfig

Der Monitoring-Worker liest diese Keys:

  • user (optional, string): Default anonymous
  • password (optional, string): Default anonymous@
  • secure (optional, boolean | "implicit"):
    • false (Default): plain FTP
    • true: explicit TLS
    • "implicit": implicit TLS (Worker nutzt default Port 990, wenn port nicht gesetzt ist)
{
  "customerId": "6764e84f-f02a-43e6-a46d-cecaec556723",
  "name": "FTP Availability",
  "hostname": "claas.sh",
  "port": 21,
  "status": "active",
  "checkInterval": 5,
  "timeoutSeconds": 30,
  "ftpConfig": {
    "user": "root",
    "password": "exampleRoot",
    "secure": "explicit"
  }
}

Duplikate

Hat dieser Kunde schon einen Monitor mit derselbe hostname (Gross- und Kleinschreibung und ein Punkt am Ende zählen nicht), port und checkMode, 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, Standard false): 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 }
}

Beispiel (cURL)

BASE_URL="https://uptimeify.io"
TOKEN="<your-api-token>"

curl -X POST \
  "$BASE_URL/api/ftp-monitors" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"customerId":"6764e84f-f02a-43e6-a46d-cecaec556723","name":"FTP Availability","hostname":"claas.sh","port":21,"status":"active","checkInterval":5,"timeoutSeconds":30,"ftpConfig":{"user":"root","password":"exampleRoot","secure":"explicit"}}'

Response

{
  "id": 400,
  "organizationId": 1,
  "customerId": 2,
  "name": "FTP Availability",
  "hostname": "claas.sh",
  "port": 21,
  "status": "active",
  "checkInterval": 5,
  "timeoutSeconds": 30,
  "allowedCheckCountryCodes": null,
  "notificationPhoneNumber": null,
  "notificationEmail": null,
  "lastCheckedAt": null,
  "createdAt": "2026-02-25T10:00:00.000Z",
  "updatedAt": "2026-02-25T10:00:00.000Z",
  "config": {
    "user": "root",
    "password": "exampleRoot",
    "secure": "explicit"
  },
  "ftpConfig": {
    "user": "root",
    "password": "exampleRoot",
    "secure": "explicit"
  }
}

Häufige Fehler

  • 400 Invalid Customer identifier wenn customerId weder gültige UUID noch Legacy-ID ist
  • 400 hostname must be a valid hostname (no protocol, no path) bei ungültigem Hostname
  • 401 Unauthorized wenn du nicht authentifiziert bist
  • 403 Forbidden wenn du keinen Zugriff hast oder keine Monitore erstellen darfst (z.B. Read-only oder Global Supporter)
  • 404 Customer not found wenn customerId nicht existiert
  • 403 targetHostMonitorLimitReached: die Organisation hat schon 100 Monitore auf diesen Ziel-Host (siehe Grenze je Ziel-Host); allowDuplicate: true hebt die Grenze nicht auf
  • 403 targetHostPlatformLimitReached: auf den Host zeigen über alle Uptimeify-Kunden schon 300 Monitore (siehe Grenze je Ziel-Host)
  • 409 monitorAlreadyExists: dieser Kunde hat schon so einen Monitor (siehe Duplikate); allowDuplicate: true legt ihn trotzdem an

Auf dieser Seite