Skip to content

API запланованих сканувань

Заплановане сканування визначає повторюване завдання. Кожне заплановане сканування створює перiодичний тригер, який спрацьовує з налаштованим iнтервалом.

Список запланованих сканувань

Повертає всi заплановані сканування для автентифiкованого tenant'у, включаючи автоматичне сканування плану.

GET /tenants/me/scheduled-scans

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

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

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

json
{
  "success": true,
  "data": [
    {
      "id": "plan",
      "isPlanSchedule": true,
      "name": "Automatic plan scan",
      "frequency": "weekly",
      "hour": 0,
      "minute": 0,
      "dayOfWeek": 0,
      "dayOfMonth": 1,
      "timezone": "UTC",
      "enabled": true,
      "scanType": "compliance",
      "lastTriggeredAt": "2026-04-07T00:00:00Z"
    },
    {
      "id": "sched_abc123",
      "isPlanSchedule": false,
      "name": "Weekly exposure scan",
      "frequency": "weekly",
      "hour": 6,
      "minute": 0,
      "dayOfWeek": 3,
      "dayOfMonth": null,
      "timezone": "Europe/London",
      "enabled": true,
      "scanType": "exposure",
      "lastTriggeredAt": "2026-04-09T06:00:00Z"
    }
  ]
}

Поля вiдповiдi

ПолеТипОпис
idstringIдентифiкатор розкладу ("plan" для автоматичного сканування)
isPlanSchedulebooleantrue, якщо це автоматичне сканування плану
namestringНазва для вiдображення
frequencystringdaily, weekly або monthly
hourintegerГодина запуску (0-23)
minuteintegerХвилина запуску (0-59)
dayOfWeekintegerДень тижня для щотижневих розкладiв (0=Пн, 6=Нд)
dayOfMonthintegerДень мiсяця для щомiсячних розкладiв (1-31)
timezonestringЧасовий пояс IANA
enabledbooleanЧи активний розклад
scanTypestringcompliance або exposure
lastTriggeredAtstring або nullЧасова мiтка ISO 8601 останнього запуску

Створення запланованого сканування

Створює нове заплановане сканування.

POST /tenants/me/scheduled-scans

Тiло запиту

json
{
  "name": "Monthly exposure scan",
  "frequency": "monthly",
  "hour": 3,
  "minute": 0,
  "dayOfMonth": 1,
  "timezone": "UTC",
  "scanType": "exposure",
  "enabled": true
}
ПолеТипОбов'язковеОпис
namestringТакНазва для вiдображення
frequencystringТакdaily, weekly або monthly
hourintegerТак0-23
minuteintegerТак0-59
dayOfWeekintegerДля weekly0=Пн, 6=Нд
dayOfMonthintegerДля monthly1-31
timezonestringТакЧасовий пояс IANA (наприклад, UTC, Europe/Berlin)
scanTypestringТакcompliance або exposure
enabledbooleanНiЗа замовчуванням true

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

bash
curl -X POST https://api.aether365.io/tenants/me/scheduled-scans \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Monthly exposure scan",
    "frequency": "monthly",
    "hour": 3,
    "minute": 0,
    "dayOfMonth": 1,
    "timezone": "UTC",
    "scanType": "exposure",
    "enabled": true
  }'

Помилки

КодHTTPОпис
SCAN_PLAN_LIMIT_REACHED429Досягнуто лiмiту власних розкладiв для плану
VALIDATION_ERROR400Вiдсутнi або невалiднi поля

Оновлення запланованого сканування

Оновлює iснуюче заплановане сканування. Змiнюються лише включенi поля.

PATCH /tenants/me/scheduled-scans/{scheduledScanId}

Приклад: Призупинення розкладу

bash
curl -X PATCH https://api.aether365.io/tenants/me/scheduled-scans/sched_abc123 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'

Приклад: Змiна години

bash
curl -X PATCH https://api.aether365.io/tenants/me/scheduled-scans/sched_abc123 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"hour": 8}'

Видалення запланованого сканування

Остаточно видаляє заплановане сканування та його базовий розклад.

DELETE /tenants/me/scheduled-scans/{scheduledScanId}

WARNING

Автоматичне сканування плану (id: "plan") неможливо видалити через API.

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

bash
curl -X DELETE https://api.aether365.io/tenants/me/scheduled-scans/sched_abc123 \
  -H "Authorization: Bearer <token>"

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

json
{
  "success": true,
  "data": null
}
Ця сторінка була корисною?