Sistem ve sağlık
Sistem ve sağlık — 4 işlem (GET /, GET /status.json, GET /healthz, …). OpenAPI 3.1.0 sözleşmesinden üretilir.
Kimlik doğrulama gerektirmeyen servis bilgisi, status sayfası verisi ve Kubernetes/izleme probları (liveness ve readiness).
Taban adres: https://api.pushizo.com · Etiket: system · Etkileşimli belge (Scalar)
İşlemler
| Yöntem | Yol | İşlem |
|---|---|---|
GET | / | Servis bilgisi |
GET | /status.json | Status page (bileşenler ve açık olaylar) |
GET | /healthz | Liveness: süreç ayakta mı? |
GET | /readyz | Readiness: veritabanı ve Redis erişilebilir mi? |
Ayrıntılar
Servis bilgisi
Kimlik doğrulama: gerekmez (herkese açık uç).
Yanıtlar
200 — Başarılı.
Gövde tanımlı değil.
Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).
Örnekler
curl -X GET "https://api.pushizo.com/"Status page (bileşenler ve açık olaylar)
Kimlik doğrulama: gerekmez (herkese açık uç).
Yanıtlar
200 — Başarılı.
Gövde tanımlı değil.
Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).
Örnekler
curl -X GET "https://api.pushizo.com/status.json"Liveness: süreç ayakta mı?
Kimlik doğrulama: gerekmez (herkese açık uç).
Yanıtlar
200 — Süreç çalışıyor.
Gövde tanımlı değil.
Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).
Örnekler
curl -X GET "https://api.pushizo.com/healthz"Readiness: veritabanı ve Redis erişilebilir mi?
Kimlik doğrulama: gerekmez (herkese açık uç).
Yanıtlar
200 — Başarılı.
Gövde tanımlı değil.
Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).
Örnekler
curl -X GET "https://api.pushizo.com/readyz"Sürümleme ve uyumluluk
/v1 uyumluluk sözü, geriye dönük uyumlu ekleme kuralları, kırıcı değişiklik politikası ve yeni sürüm yolu, kullanımdan kaldırma, OpenAPI/SDK sürümleri ve değişiklik günlüğü.
App’ler
App’ler — 7 işlem (GET /v1/organization, GET /v1/organization/members, GET /v1/organization/audit-logs, …). OpenAPI 3.1.0 sözleşmesinden üretilir.