Skip to content

API wyników

Autor: Zespół Aether365 Odbiorcy: Deweloperzy Zakres: Endpointy API wyników - pobieranie znalezisk ze skanów

Pobieranie wyników skanu

Zwraca poszczególne wyniki kontroli dla zakończonego skanu.

GET /scans/{scanId}/results

Parametry zapytania

ParametrTypOpis
pageintegerNumer strony (domyślnie: 1)
limitintegerWyników na stronę (domyślnie: 50, maks.: 200)
resultstringFiltruj: passed, failed, skipped
severitystringFiltruj: critical, high, medium, low
frameworkstringFiltruj według frameworku: cis, eidsca, cisa, nis2

Przykładowe żądanie

bash
curl "https://api.aether365.io/scans/scan_abc123/results?result=failed&severity=critical" \
  -H "Authorization: Bearer <token>"

Przykładowa odpowiedź

json
{
  "success": true,
  "data": [
    {
      "id": "result_001",
      "scan_id": "scan_abc123",
      "test_id": "CIS.M365.1.1.1",
      "title": "Ensure multifactor authentication is enabled for all users in administrative roles",
      "result": "failed",
      "severity": "critical",
      "framework": "cis",
      "help_url": "https://www.cisecurity.org/benchmark/microsoft_365",
      "remediation_steps": "1. Sign in to the Azure portal...",
      "source_tool": "compliance"
    }
  ],
  "meta": {
    "total": 12,
    "page": 1,
    "limit": 50
  }
}

Pobieranie pojedynczego wyniku

Zwraca szczegóły jednego indywidualnego wyniku kontroli.

GET /scans/{scanId}/results/{testId}

Przykładowe żądanie

bash
curl https://api.aether365.io/scans/scan_abc123/results/CIS.M365.1.1.1 \
  -H "Authorization: Bearer <token>"

Przykładowa odpowiedź

json
{
  "success": true,
  "data": {
    "id": "result_001",
    "scan_id": "scan_abc123",
    "test_id": "CIS.M365.1.1.1",
    "title": "Ensure multifactor authentication is enabled for all users in administrative roles",
    "result": "failed",
    "severity": "critical",
    "framework": "cis",
    "help_url": "https://www.cisecurity.org/benchmark/microsoft_365",
    "remediation_steps": "1. Sign in to the Azure portal as a Global Administrator.\n2. Navigate to Microsoft Entra ID > Security > Conditional Access.\n3. Create or update a policy requiring MFA for all administrator roles.",
    "raw_output": {},
    "source_tool": "compliance"
  }
}

Referencja pól

PoleTypOpis
test_idstringUnikalny identyfikator kontroli (np. CIS.M365.1.1.1)
titlestringNazwa kontroli zrozumiała dla człowieka
resultstringpassed, failed lub skipped
severitystringcritical, high, medium lub low
frameworkstringFramework definiujący kontrolę (cis, eidsca, cisa, nis2)
help_urlstringLink do oficjalnej dokumentacji lub referencji benchmarku
remediation_stepsstringInstrukcje naprawcze krok po kroku
source_toolstringTyp silnika skanowania (compliance lub exposure)
raw_outputobjectSurowe dane ewaluacji (może być null dla niektórych kontroli)
Czy ta strona była pomocna?