Skip to content

API Referansı

Hazırlayan: Aether365 Ekibi Hedef Kitle: Geliştiriciler ve DevOps mühendisleri Kapsam: Aether365 REST API genel bakışı, temel URL ve yanıt formatı

Aether365 API, tarama verilerine programatik olarak erişmenize, tarama başlatmanıza, tenant'ları yönetmenize ve AI Pilot'u yönlendirmenize olanak tanır: otomatik remediation'ları üretme, inceleme ve uygulama, kimlik riski sinyallerini okuma ve politikaları sıkılaştırma.

Endpoint grupları

AlanKapsadığı işlevler
TaramalarUyumluluk ve exposure taramalarını tetikle ve listele
SonuçlarTek tek tarama bulgularını oku
AI PilotOtomatik remediation planlarını üret, incele ve uygula
Threat AlertsKimlik riski sinyalleri ve tek tıkla kullanıcı sınırlama
PolitikalarPolitika duruşunu oku ve izin listesindeki politikaları sıkılaştır
Tenant'larTenant profilini oku ve güncelle
BağlantılarBağlı Microsoft 365 tenant'larını yönet
Zamanlanmış TaramalarYinelenen taramaları otomatikleştir

Temel URL

https://api.aether365.io

Tüm endpoint'ler bu temel URL'ye görelidir.

Kimlik Doğrulama

API, Bearer token kimlik doğrulaması kullanır. Her isteğin Authorization başlığında geçerli bir JWT token ekleyin:

Authorization: Bearer <token>

Token'lar Aether365'in kimlik doğrulama sistemi tarafından verilir. Token elde etme hakkında ayrıntılar için Kimlik Doğrulama sayfasına bakın.

Yanıt Formatı

Tüm API yanıtları tutarlı bir JSON yapısı kullanır.

Başarılı Yanıt

json
{
  "success": true,
  "data": {}
}

Liste endpoint'leri için:

json
{
  "success": true,
  "data": [],
  "meta": {
    "total": 142,
    "page": 1,
    "limit": 20
  }
}

İşlem endpoint'leri (tetikleme, silme) için:

json
{
  "success": true,
  "data": null
}

Hata Yanıtı

json
{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Okunabilir açıklama",
    "details": {}
  }
}

HTTP Durum Kodları

KodAnlamı
200Başarılı
201Kaynak oluşturuldu
400Geçersiz istek - eksik veya hatalı parametreler
401Kimlik doğrulama gerekli veya token geçersiz
403Erişim engellendi - tenant izolasyonu ihlali
404Kaynak bulunamadı
409Çakışma - örneğin, bir tarama zaten çalışıyor
429Plan limiti aşıldı
500Sunucu hatası

Hata Kodları

KodAçıklama
AUTH_MISSING_TOKENAuthorization başlığı mevcut değil
AUTH_INVALID_TOKENToken doğrulanamadı
AUTH_EXPIRED_TOKENToken süresi dolmuş
TENANT_NOT_FOUNDTenant mevcut değil
TENANT_NOT_CONNECTEDMicrosoft onayı tamamlanmamış
SCAN_NOT_FOUNDTarama kimliği mevcut değil
SCAN_ALREADY_RUNNINGBu tenant için bir tarama zaten devam ediyor
SCAN_PLAN_LIMIT_REACHEDMevcut plan için tarama kotası tükenmiş
VALIDATION_ERRORİstek gövdesi veya sorgu parametreleri geçersiz
INTERNAL_ERRORBeklenmeyen sunucu hatası

Hız Sınırları

API, dakikada 120 istekle sınırlıdır. Hız sınırını aşmak 429 Too Many Requests döndürür. Retry-After başlığı, yeniden denemeden önce kaç saniye beklemeniz gerektiğini gösterir.

Bu sayfa işinize yaradı mı?