Nuskaitymų API

Autorius: Aether365 komanda Auditorija: Kūrėjai Apimtis: Nuskaitymų API galutiniai taškai - nuskaitymų inicijavimas ir sąrašo gavimas

Nuskaitymų sąrašas

Grąžina puslapiais pateikiamą autentifikuotos organizacijos nuskaitymų sąrašą.

GET /tenants/{tenantId}/scans

Užklausos parametrai

Parametras	Tipas	Aprašymas
page	integer	Puslapio numeris (numatytasis: 1)
limit	integer	Rezultatų skaičius puslapyje (numatytasis: 20, maks.: 100)
status	string	Filtruoti pagal būseną: in_progress, completed, failed
scan_type	string	Filtruoti pagal tipą: compliance, exposure

Užklausos pavyzdys

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

Atsakymo pavyzdys

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

---

Nuskaitymo gavimas

Grąžina vieno nuskaitymo detales.

GET /scans/{scanId}

Užklausos pavyzdys

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

Atsakymo pavyzdys

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

---

Nuskaitymo inicijavimas

Iš karto pradeda nuskaitymą nurodytai organizacijai.

POST /tenants/{tenantId}/scans

Užklausos turinys

{
  "scan_type": "compliance"
}

Laukas	Tipas	Būtinas	Reikšmės
scan_type	string	Taip	compliance, exposure

Užklausos pavyzdys

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

Atsakymo pavyzdys

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

Klaidos

Kodas	HTTP	Aprašymas
SCAN_ALREADY_RUNNING	409	Šio tipo nuskaitymas jau vykdomas šiai organizacijai
TENANT_NOT_CONNECTED	400	Microsoft sutikimas neužbaigtas šiai organizacijai
SCAN_PLAN_LIMIT_REACHED	429	Nuskaitymų kvota išnaudota dabartiniam atsiskaitymo laikotarpiui