Skip to content

Heartbeat#

An approved coordinator reports that it is alive by POSTing a heartbeat. The public page and the directory show an "online / delayed" badge based on it.

curl -s -X POST https://modelen.tr/api/v1/koordinator/nabiz \
  -H "Authorization: Bearer $MODELEN_API_ANAHTARI" -H "Content-Type: application/json" \
  -d '{"durum":"calisiyor","tur":3,"toplam_tur":20,"aktif_isci":7,"protokol":"1","surum":"0.4.0"}'
FieldTypeRequiredMeaning
durumstringyescalisiyor (running), bekliyor (waiting), bakimda (maintenance), durdu (stopped)
tur, toplam_tur, aktif_isciinteger ≥ 0nocurrent round, planned rounds, active workers
protokolstring ≤ 10noe.g. "1"
surumstring ≤ 30noyour software version
mesajstring ≤ 120noshort note

Unknown fields → 400 bilinmeyen_alan. Only approved coordinators may send (403 onayli_degil). Limit: 6 per minute.

Public status#

StatusCondition
cevrimici (online)running/waiting and last heartbeat ≤ 15 min ago
gecikmeli (delayed)running/waiting and last heartbeat ≤ 24 h ago
bakimda / durdureported in the last 24 h
bilinmiyor (unknown)none, or older than 24 h

So send at least every 15 minutes; every 5 minutes is a good interval. With the example client:

python istemci/ornekler/modelen_api.py nabiz-dongusu --koordinator http://127.0.0.1:8750 --aralik 300