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

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

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

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

GET /tenants/me/scheduled-scans

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

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

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

{
  "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": "Custom compliance scan",
      "frequency": "weekly",
      "hour": 6,
      "minute": 0,
      "dayOfWeek": 3,
      "dayOfMonth": null,
      "timezone": "Europe/London",
      "enabled": true,
      "scanType": "compliance",
      "lastTriggeredAt": "2026-04-09T06:00:00Z"
    }
  ]
}

Поля відповіді

Поле	Тип	Опис
id	string	Ідентифікатор розкладу ("plan" для автоматичного сканування)
isPlanSchedule	boolean	true, якщо це автоматичне сканування плану
name	string	Назва для відображення
frequency	string	daily, weekly або monthly
hour	integer	Година запуску (0-23)
minute	integer	Хвилина запуску (0-59)
dayOfWeek	integer	День тижня для щотижневих розкладів (0=Пн, 6=Нд)
dayOfMonth	integer	День місяця для щомісячних розкладів (1-31)
timezone	string	Часовий пояс IANA
enabled	boolean	Чи активний розклад
scanType	string	compliance
lastTriggeredAt	string або null	Часова мітка ISO 8601 останнього запуску

---

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

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

POST /tenants/me/scheduled-scans

Тіло запиту

{
  "name": "Custom compliance scan",
  "frequency": "monthly",
  "hour": 3,
  "minute": 0,
  "dayOfMonth": 1,
  "timezone": "UTC",
  "scanType": "compliance",
  "enabled": true
}

Поле	Тип	Обов'язкове	Опис
name	string	Так	Назва для відображення
frequency	string	Так	daily, weekly або monthly
hour	integer	Так	0-23
minute	integer	Так	0-59
dayOfWeek	integer	Для weekly	0=Пн, 6=Нд
dayOfMonth	integer	Для monthly	1-31
timezone	string	Так	Часовий пояс IANA (наприклад, UTC, Europe/Berlin)
scanType	string	Так	compliance
enabled	boolean	Ні	За замовчуванням true

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

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

Помилки

Код	HTTP	Опис
SCAN_PLAN_LIMIT_REACHED	429	Досягнуто ліміту власних розкладів для плану
VALIDATION_ERROR	400	Відсутні або невалідні поля

---

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

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

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

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

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}'

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

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.

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

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

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

{
  "success": true,
  "data": null
}