Health API
Yük dengeleyiciler, Docker sağlık kontrolleri ve bir örneğin nasıl yapılandırıldığını keşfeden istemciler için herkese açık liveness ve deployment-info probları.
Health API, Alaf Server dışındaki her şeyin bir örneğin canlı olup olmadığını kontrol etme ve nasıl kurulduğunu (sürümü, auth modu ve hedeflediği cloud (varsa)) öğrenme yöntemidir. Yük dengeleyiciler ve Docker sağlık kontrolleri GET /api/health adresine istek gönderir; CLI ve dashboard, hangi login akışını göstereceğine karar vermek için GET /api/health/env adresini okur. Terminalden bu, alaf server status komutudur. Her iki route da her örnekte (self-hosted, desktop ve cloud) mevcuttur.
Temel yol ve auth
Tüm yollar, örneğinize göre /api altında yer alır — örn. https://your-host/api/health. Her iki endpoint de herkese açıktır — token veya session gerekmez, bu nedenle problar login öncesinde ve yük dengeleyicilerden çalışır. Başka yerlerdeki authenticated çağrılar, bir bearer header olarak kişisel bir access token gönderir (Authorization: Bearer <token>, alaf server token create ile oluşturulur); dashboard bir session cookie kullanır. Ayrıntılar için API genel bakışına ve auth modeline bakın.
Endpointler
| Metot ve yol | İzin | Ne işe yarar |
|---|---|---|
GET /api/health | herkese açık | Liveness probe — { status, timestamp } döndürür. |
GET /api/health/env | herkese açık | Statik deployment bilgisi: mod, sürüm, auth/team modu ve cloud URL'leri. |
Liveness probe
GET /api/healthSüreç istekleri karşıladığı sürece sabit bir body ile 200 döndürür. Bunu bir container veya yük dengeleyici sağlık kontrolü olarak kullanın — hiçbir veritabanına dokunmaz ve asla auth gerektirmez.
curl https://your-host/api/health
# → {"status":"ok","timestamp":"2026-07-19T04:29:00.000Z"}Deployment bilgisi
GET /api/health/envÖrneğin nasıl yapılandırıldığına dair statik, cache dostu bir açıklama. İstemciler, doğru login akışını seçmek ve doğru cloud endpoint'lerine ulaşmak için bunu okur — dashboard, sabit kodlanmış bir tablo yerine bu değerleri kullanır. Veritabanına bağlı okumalar (teamMode, migration alanları), ayarlar tablosu migration ortasında kullanılamaz hale gelirse güvenli varsayılanlara geri döner, böylece bu route çalışır durumda kalır.
Yanıt yapısı:
Prop
Type
curl https://your-host/api/health/env# CLI'dan aynı bilgi (--json ekleyerek ham payload'ı alabilirsiniz):
alaf server statusGörebileceğiniz hatalar
Bağlantı reddedildi / zaman aşımı
Bu route'lar asla bir auth veya izin hatası döndürmez — bir hata, sürecin erişilemez olduğu anlamına gelir (yanlış host/port, container hala başlıyor veya örnek kapalı). alaf server status bunu Cannot reach the API at <url> olarak rapor eder. Örneğin çalıştığını ve URL'nin doğru olduğunu onaylayın, ardından tekrar deneyin.