Taramalar API

Hazırlayan: Aether365 Ekibi Hedef Kitle: Geliştiriciler Kapsam: Tarama API endpoint'leri - tarama tetikleme ve listeleme

Taramaları Listeleme

Kimlik doğrulanmış tenant için sayfalanmış tarama listesini döndürür.

GET /tenants/{tenantId}/scans

Sorgu Parametreleri

Parametre	Tür	Açıklama
page	integer	Sayfa numarası (varsayılan: 1)
limit	integer	Sayfa başına sonuç (varsayılan: 20, maksimum: 100)
status	string	Duruma göre filtre: in_progress, completed, failed
scan_type	string	Türe göre filtre: compliance, exposure

Örnek İstek

curl https://api.aether365.io/tenants/t_abc123/scans \
  -H "Authorization: Bearer <token>"

Örnek Yanıt

{
  "success": true,
  "data": [
    {
      "id": "scan_abc123",
      "tenant_id": "t_abc123",
      "scan_type": "compliance",
      "status": "completed",
      "started_at": "2026-04-09T00:00:00Z",
      "completed_at": "2026-04-09T00:14:23Z",
      "pass_count": 87,
      "fail_count": 12,
      "skip_count": 5,
      "score": 87.9
    }
  ],
  "meta": {
    "total": 24,
    "page": 1,
    "limit": 20
  }
}

---

Tarama Detayını Alma

Tek bir taramanın ayrıntılarını döndürür.

GET /scans/{scanId}

Örnek İstek

curl https://api.aether365.io/scans/scan_abc123 \
  -H "Authorization: Bearer <token>"

Örnek Yanıt

{
  "success": true,
  "data": {
    "id": "scan_abc123",
    "tenant_id": "t_abc123",
    "scan_type": "compliance",
    "status": "completed",
    "started_at": "2026-04-09T00:00:00Z",
    "completed_at": "2026-04-09T00:14:23Z",
    "pass_count": 87,
    "fail_count": 12,
    "skip_count": 5,
    "score": 87.9
  }
}

---

Tarama Başlatma

Belirtilen tenant için hemen bir tarama başlatır.

POST /tenants/{tenantId}/scans

İstek Gövdesi

{
  "scan_type": "compliance"
}

Alan	Tür	Gerekli	Değerler
scan_type	string	Evet	compliance, exposure

Örnek İstek

curl -X POST https://api.aether365.io/tenants/t_abc123/scans \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"scan_type": "compliance"}'

Örnek Yanıt

{
  "success": true,
  "data": {
    "id": "scan_xyz789",
    "tenant_id": "t_abc123",
    "scan_type": "compliance",
    "status": "in_progress",
    "started_at": "2026-04-09T10:32:00Z",
    "completed_at": null,
    "pass_count": null,
    "fail_count": null,
    "skip_count": null,
    "score": null
  }
}

Hatalar

Kod	HTTP	Açıklama
SCAN_ALREADY_RUNNING	409	Bu tenant için bu türde bir tarama zaten devam ediyor
TENANT_NOT_CONNECTED	400	Bu tenant için Microsoft onayı tamamlanmamış
SCAN_PLAN_LIMIT_REACHED	429	Mevcut fatura dönemi için tarama kotası tükenmiş