Skip to content

API сканувань

Список сканувань

Повертає посторiнковий список сканувань для автентифiкованого tenant'у.

GET /tenants/{tenantId}/scans

Параметри запиту

ПараметрТипОпис
pageintegerНомер сторiнки (за замовчуванням: 1)
limitintegerРезультатiв на сторiнку (за замовчуванням: 20, макс: 100)
statusstringФiльтр за статусом: in_progress, completed, failed
scan_typestringФiльтр за типом: compliance, exposure

Приклад запиту

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

Приклад вiдповiдi

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

Отримання сканування

Повертає деталi окремого сканування.

GET /scans/{scanId}

Приклад запиту

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

Приклад вiдповiдi

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

Запуск сканування

Негайно запускає сканування для вказаного tenant'у.

POST /tenants/{tenantId}/scans

Тiло запиту

json
{
  "scan_type": "compliance"
}
ПолеТипОбов'язковеЗначення
scan_typestringТакcompliance, exposure

Приклад запиту

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

Приклад вiдповiдi

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

Помилки

КодHTTPОпис
SCAN_ALREADY_RUNNING409Сканування цього типу вже виконується для цього tenant'у
TENANT_NOT_CONNECTED400Згода Microsoft не завершена для цього tenant'у
SCAN_PLAN_LIMIT_REACHED429Квота сканувань вичерпана за поточний розрахунковий перiод
Ця сторінка була корисною?