Scans API

Betreut von: Aether365 Team Zielgruppe: Entwickler Umfang: Scan API-Endpunkte - Scans auslösen und auflisten

Scans auflisten

Gibt eine paginierte Liste von Scans für den authentifizierten Tenant zurück.

GET /tenants/{tenantId}/scans

Abfrageparameter

Parameter	Typ	Beschreibung
page	integer	Seitennummer (Standard: 1)
limit	integer	Ergebnisse pro Seite (Standard: 20, Maximum: 100)
status	string	Nach Status filtern: in_progress, completed, failed
scan_type	string	Nach Typ filtern: compliance, exposure

Beispielanfrage

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

Beispielantwort

{
  "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
  }
}

---

Scan abrufen

Gibt Details eines einzelnen Scans zurück.

GET /scans/{scanId}

Beispielanfrage

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

Beispielantwort

{
  "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
  }
}

---

Einen Scan auslösen

Startet sofort einen Scan für den angegebenen Tenant.

POST /tenants/{tenantId}/scans

Anfragekörper

{
  "scan_type": "compliance"
}

Feld	Typ	Erforderlich	Werte
scan_type	string	Ja	compliance, exposure

Beispielanfrage

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

Beispielantwort

{
  "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
  }
}

Fehler

Code	HTTP	Beschreibung
SCAN_ALREADY_RUNNING	409	Ein Scan dieses Typs läuft bereits für diesen Tenant
TENANT_NOT_CONNECTED	400	Microsoft Consent wurde für diesen Tenant nicht abgeschlossen
SCAN_PLAN_LIMIT_REACHED	429	Scan-Kontingent für den aktuellen Abrechnungszeitraum erschöpft