Uptimeify Docs

TCP Monitor aktualisieren

Aktualisiert einen TCP Monitor und/oder ändert den Status.

PATCH /api/tcp-monitors/:tcpMonitorPublicId

Authentifizierung

Erfordert eine gültige Session.

  • Header: Authorization: Bearer <token>

Parameter

  • tcpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des TCP Monitors.

Request Body

Alle Felder sind optional.

{
 "name": "Redis Primary",
 "hostname": "redis.example.com",
 "port": 6379,
 "status": "paused",
 "checkInterval": 60,
 "timeoutSeconds": 30,
 "allowedCheckCountryCodes": ["de", "ch"],
 "config": {
  "expectBanner": "+PONG"
 }
}

Hinweise

  • status akzeptiert active, maintenance, disabled, paused, inactive.
  • paused und inactive werden zu disabled normalisiert.
  • port muss, falls angegeben, eine Ganzzahl zwischen 1 und 65535 sein.
  • allowedCheckCountryCodes wird zu Uppercase ISO Codes normalisiert (z. B. DE, US). Leere Listen werden zu null.
  • config akzeptiert nur den Key expectBanner (wird in die bestehende gespeicherte Config gemergt). Es gibt keinen sshConfig-artigen Alias und keine Zugangsdaten-Felder — TCP-Monitore enthalten keine Zugangsdaten. Wenn weggelassen, bleibt die gespeicherte Config unverändert.
  • Nutzer mit Rolle readonly können nur status ändern.

cURL

curl -X PATCH "https://YOUR_DOMAIN/api/tcp-monitors/44444444-4444-4444-8444-444444444444" \
 -H "Authorization: Bearer $TOKEN" \
 -H "Content-Type: application/json" \
 -d '{
  "status": "disabled"
 }'

Response

{
 "id": 300,
 "publicId": "44444444-4444-4444-8444-444444444444",
 "organizationId": 1,
 "customerId": 10,
 "name": "Redis Primary",
 "hostname": "redis.example.com",
 "port": 6379,
 "status": "disabled",
 "managementType": "managed",
 "checkInterval": 60,
 "timeoutSeconds": 30,
 "notificationEmail": null,
 "notificationPhoneNumber": null,
 "lastCheckedAt": "2026-02-26T12:00:00.000Z",
 "createdAt": "2026-02-26T12:00:00.000Z",
 "updatedAt": "2026-02-26T12:01:00.000Z",
 "config": {
  "expectBanner": "+PONG"
 }
}

Errors

  • 400 TCP Monitor Public ID (UUID) erforderlich / ungültige Felder (z. B. invalidPort, invalidConfig, invalidStatus)
  • 401 Unauthorized
  • 403 Forbidden (readonly darf nur status ändern; global supporters dürfen nicht updaten)
  • 404 Not found

Auf dieser Seite