API за сканирания
Списък със сканирания
Връща страниран списък със сканирания за удостоверения tenant.
GET /tenants/{tenantId}/scansПараметри на заявката
| Параметър | Тип | Описание |
|---|---|---|
page | integer | Номер на страница (по подразбиране: 1) |
limit | integer | Резултати на страница (по подразбиране: 20, максимум: 100) |
status | string | Филтър по статус: in_progress, completed, failed |
scan_type | string | Филтър по тип: compliance, exposure |
Примерна заявка
bash
curl https://api.aether365.io/tenants/t_abc123/scans \
-H "Authorization: Bearer <token>"Примерен отговор
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
}
}Получаване на сканиране
Връща детайли за отделно сканиране.
GET /scans/{scanId}Примерна заявка
bash
curl https://api.aether365.io/scans/scan_abc123 \
-H "Authorization: Bearer <token>"Примерен отговор
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Тяло на заявката
json
{
"scan_type": "compliance"
}| Поле | Тип | Задължително | Стойности |
|---|---|---|---|
scan_type | string | Да | 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"}'Примерен отговор
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_RUNNING | 409 | Сканиране от този тип вече е в ход за този tenant |
TENANT_NOT_CONNECTED | 400 | Съгласието на Microsoft не е завършено за този tenant |
SCAN_PLAN_LIMIT_REACHED | 429 | Квотата за сканирания е изчерпана за текущия период на таксуване |