TCP Check triggern

POST /api/tcp-monitors/:tcpMonitorPublicId/trigger-check

Authentifizierung

Erfordert eine gültige Session und Schreibrechte.

• Header: Authorization: Bearer <token>

Parameter

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

Hinweise

• Der Standort wird deterministisch aus den aktuell aktiven Monitoring-Standorten gewählt (gefiltert nach allowedCheckCountryCodes des Monitors bzw. des Kunden, falls gesetzt).
• Pro Monitor rate-limited über einen kurzen Cooldown; zu schnelles erneutes Triggern liefert 429.

cURL

curl -X POST "https://YOUR_DOMAIN/api/tcp-monitors/44444444-4444-4444-8444-444444444444/trigger-check" \
  -H "Authorization: Bearer $TOKEN"

Response

{
  "success": true,
  "message": "Check triggered successfully",
  "tcpMonitorId": 300,
  "locationCode": "de-nbg",
  "queueName": "tcp-monitor-checks-de-nbg"
}

Errors

• 400 Keine zulässigen Monitoring-Standorte für die ausgewählten Länder
• 401 Unauthorized
• 403 Forbidden
• 404 Not found
• 429 Check wurde kürzlich bereits getriggert — erneut nach dem Cooldown versuchen (retryAfterMs im Error-Payload)
• 500 / 503 Failed to trigger check (z. B. "No active monitoring locations available")