Yardım ve kılavuzlarAPI ve entegrasyonlar › API endpoint genel bakış

API endpoint genel bakış

5 dk okuma · API ve entegrasyonlar

Mevcut tüm API uç noktalarının (çağrı yaptığınız REST API'nin ayrı URL adreslerinin) genel görünümü. Temel URL: https://epulz.io/api/v1

Yetkilendirme: Authorization: Bearer epulzio_... başlığını gönderin. İstek sınırı (rate limit) token başına dakikada 60 istektir. Token'ı Ayarlar -> API token'ları bölümünden oluşturursunuz.

REST API erişimi için API token yönetimi
API çağrıları için kullanılan token'ı API token'ları bölümünde oluşturur ve yönetirsiniz.

Durum / token denetimi

  • GET /status - token'ı doğrular; e-posta, plan, monitör sayısı ve açık olay sayısını döndürür.

Monitörler

  • GET /monitors - tüm monitörlerinizin listesi (son 24 saatlik erişilebilirlik dahil).
  • GET /monitors/{id} - tek bir monitörün ayrıntısı.
  • POST /monitors - yeni bir monitör oluşturur. İstek gövdesinde (JSON) name, type, target, interval_minutes, expected_status, expected_keyword, forbidden_keyword alanlarını gönderin.
  • POST /monitors/bulk - toplu içe aktarma (tek bir istekte en fazla 200 monitör).
  • PATCH /monitors/{id} - mevcut bir monitörün düzenlenmesi (yalnızca değiştirmek istediğiniz alanları gönderin).
  • POST /monitors/{id}/check - planlanan aralığın dışında anında bir denetim başlatır; güncellenmiş monitörü döndürür.
  • GET /monitors/{id}/uptime?days=30 - son N gündeki % erişilebilirlik (1-365, varsayılan 30); bakım pencereleri hariç tutulur.
  • DELETE /monitors/{id} - monitörü siler (denetim ve olay geçmişiyle birlikte).

Denetimler (geçmiş)

  • GET /monitors/{id}/checks?limit=100 - bir monitörün son N denetimi (durum, yanıt süresi, HTTP status code, varsa hata, bölge). limit parametresi 1 ile 500 arasında olabilir, varsayılan 50.

Olaylar

  • GET /incidents - olayların listesi. İsteğe bağlı filtreler: monitor_id, resolved (true/false), limit (1-500, varsayılan 50).

Hata kodları

  • 401 - eksik veya geçersiz token.
  • 403 - planınızın monitör sınırı aşıldı (oluşturma sırasında).
  • 404 - monitör size ait değil veya mevcut değil.
  • 429 - istek sınırı aşıldı (token başına dakikada 60).

Makine tarafından okunabilir belgeler

OpenAPI standardındaki tam belirtim /api/openapi.json adresinde mevcuttur. Uç noktaları doğrudan deneyebileceğiniz etkileşimli belgeleri (Swagger UI) /api/docs adresinde bulabilirsiniz. Her ikisi de oturum açmayı veya geçerli bir token gerektirir.

Bu kılavuz yardımcı oldu mu?