diff --git a/Agent-Endpoints.-.md b/Agent-Endpoints.-.md index 851b844..4e68ca5 100644 --- a/Agent-Endpoints.-.md +++ b/Agent-Endpoints.-.md @@ -1,14 +1,45 @@ # Übersicht der Endpoints ## /heartbeat/receive -An diesen Endpoint wird unabhängig von Monitoring-Daten alle 60 Sekunden ein Heartbeat-Payload geschickt, um dem Server mitzuteilen, ob der Server noch online ist. +An diesen Endpoint wird unabhängig von Monitoring-Daten alle 60 Sekunden ein Heartbeat-Payload geschickt, um dem Server mitzuteilen, ob der Agent-Host noch online ist. Struktur des Payloads: + ```json { } ``` +Der Server antwortet bei Eingang des Pakets mit "OK" oder bei einem falsch gebauten Payload mit "NotFound". + ## /monitoring/register +An diesen Endpoint schickt der Agent bei seinem ersten Start folgenden Payload: + +```json +{ +} +``` + +Der Server prüft anhand der eingegangenen IP-Adresse, ob der Agent-Host in der Datenbank bereits existiert. Ist das der Fall, schickt er folgende Nachricht zurück: + +```json +{ +} +``` + +Die eingegangen Hardware-Informationen, werden im Datenbankeintrag des Agent-Hosts hinterlegt. + +Existiert der Agent-Host noch nicht in der Datenbank, antwortet der Server mit "NotFound". + + ## /monitoring/receive +An diesen Endpoint schickt der Agent-Host alle 60 Sekunden folgenden Payload: + +```json +{ +} +``` +Der Server antwortet bei Eingang des Pakets mit "OK" oder bei einem falsch gebauten Payload mit "NotFound". + +Die Daten werden vom Server weiter verarbeitet und in der Datenbank für X Tage gespeichert. \ No newline at end of file