API

Denetim API'si

Kuruluşunuzun yalnızca eklemeli denetim günlüğünü (kim neyi ne zaman yaptı) imleç veya sayfa numaralandırma ve filtrelerle okuyun.

Denetim API'si, aktif kuruluşunuzun yalnızca eklemeli denetim günlüğünün salt okunur bir akışıdır: önemli her eylem (oturum açmalar, üye değişiklikleri, deploy'lar, ayarlar düzenlemeleri ve daha fazlası) için bir olay, en yeniler önce. dashboard'da bu, Denetim sayfasıdır; özel bir CLI komutu yoktur — alaf server api aracılığıyla erişebilirsiniz.

Temel yol ve kimlik doğrulama

Tüm yollar, örneğinizle ilişkilidir, /api altında — örn. https://your-host/api/audit. alaf server token create ile oluşturulmuş bir kişisel erişim token'ını bir bearer header (Authorization: Bearer <token>) olarak gönderin. dashboard bunun yerine oturum çerezinizi kullanır. Tam kimlik doğrulama modeli için API genel bakışına bakın.

Uç Noktalar

Metot ve yolİzinNe işe yarar
GET /api/auditaudit:readAktif kuruluş için denetim olaylarını (en yeniler önce), imleç veya sayfa numaralandırma ve filtrelerle listeler.

Denetim olaylarını listele

GET /api/audit

Her olay, aktif kuruluşunuzla sınırlıdır. Erişim role göre belirlenir: sahipler ve yöneticiler günlüğü her zaman görür, sıradan üyeler reddedilir ve kısıtlı kullanıcıların kuruluş düzeyindeki audit kaynağında açık bir audit:read iznine ihtiyacı vardır. İzinler ve roller bölümüne bakın.

Sorgu parametreleri

Tüm parametreler isteğe bağlıdır. Bir numaralandırma modu seçin: cursor (anahtar kümesi) veya page/perPage (ofset) geçirin. İmleç modu, sayfaları akışla sağlayan her şey için önerilir — eşzamanlı yazımlarda satırları kaydırmadan çalışır; sayfa modu, dashboard'un "N'den 1-50 arası gösteriliyor" sayısını destekler.

Prop

Type

Yanıt

Her olay satırı id, eventType, resourceType, resourceId, before/after JSON anlık görüntülerini (yalnızca mutasyon olayları için; aksi takdirde null), ipAddress, userAgent ve createdAt değerlerini taşır. Satırlar, actorUserId'den çözümlenen bir actor nesnesi ({ id, email, name }) ile zenginleştirilir veya sistem tarafından yayılan olaylar için null olur.

Sayfalandırma zarfı moda bağlıdır:

  • İmleç modu{ data, pageInfo: { hasNextPage, endCursor } }. Sonraki sayfa için endCursor değerini cursor olarak geri geçirin; total yoktur.
  • Ofset modu{ data, total, page, perPage }.
# İmleç modu — en yeni 50 deployment-failure olayı
curl -G https://your-host/api/audit \
  -H "Authorization: Bearer $ALAFSERVER_TOKEN" \
  --data-urlencode "cursor=" \
  --data-urlencode "limit=50" \
  --data-urlencode "eventType=deployment.failed"
# CLI kaçış yoluyla aynı şey (yol /api'ye göredir):
alaf server api /audit -q eventType=deployment.failed -q limit=50

Görebileceğiniz hatalar

403 — izin verilmedi

Rolünüz denetim günlüğünü okuyamaz. Üyelere varsayılan olarak izin verilmez; bir sahip/yöneticiye kuruluşun audit kaynağında audit:read izni vermesini isteyin veya günlüğü bir yönetici hesabından görüntüleyin. İzinler ve roller bölümüne bakın.

Boş sonuçlar, hata değil

Hiçbir şeyle eşleşmeyen filtreler, boş bir data dizisiyle 200 döndürür. eventType yazımını (tam nokta ad alanlı etikettir) ve resourceId'nin kuruluşunuza ait olduğunu iki kez kontrol edin. Saklama süresi kuruluş tarafından yapılandırılabilir (varsayılan 90 gün), bu nedenle pencereden daha eski olaylar budanır ve görünmez.

On this page