API plánovaných skenov

Plánované skeny definujú opakujúce sa úlohy skenovania. Každý plánovaný sken definuje opakujúci sa spúšťač, ktorý sa aktivuje v nastavenom intervale.

Zoznam plánovaných skenov

Vráti všetky plánované skeny pre autentifikovaného tenanta vrátane automatického skenu podľa plánu.

GET /tenants/me/scheduled-scans

Príklad požiadavky

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

Príklad odpovede

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

Polia odpovede

Pole	Typ	Popis
id	string	Identifikátor harmonogramu ("plan" pre automatický plánový sken)
isPlanSchedule	boolean	true ak ide o automatický sken podľa plánu
name	string	Zobrazovaný názov
frequency	string	daily, weekly alebo monthly
hour	integer	Hodina spustenia (0-23)
minute	integer	Minúta spustenia (0-59)
dayOfWeek	integer	Deň v týždni pre týždenné harmonogramy (0=Po, 6=Ne)
dayOfMonth	integer	Deň v mesiaci pre mesačné harmonogramy (1-31)
timezone	string	IANA časové pásmo
enabled	boolean	Či je harmonogram aktívny
scanType	string	compliance alebo exposure
lastTriggeredAt	string alebo null	Časová pečiatka ISO 8601 posledného spustenia

---

Vytvorenie plánovaného skenu

Vytvorí nový plánovaný sken.

POST /tenants/me/scheduled-scans

Telo požiadavky

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

Pole	Typ	Povinné	Popis
name	string	Áno	Zobrazovaný názov
frequency	string	Áno	daily, weekly alebo monthly
hour	integer	Áno	0-23
minute	integer	Áno	0-59
dayOfWeek	integer	Pre weekly	0=Po, 6=Ne
dayOfMonth	integer	Pre monthly	1-31
timezone	string	Áno	IANA časové pásmo (napr. UTC, Europe/Berlin)
scanType	string	Áno	compliance alebo exposure
enabled	boolean	Nie	Predvolené: true

Príklad požiadavky

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

Chyby

Kód	HTTP	Popis
SCAN_PLAN_LIMIT_REACHED	429	Dosiahnutý limit vlastných harmonogramov pre váš plán
VALIDATION_ERROR	400	Chýbajúce alebo neplatné polia

---

Aktualizácia plánovaného skenu

Aktualizuje existujúci plánovaný sken. Aktualizujú sa iba zahrnuté polia.

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

Príklad: Pozastavenie harmonogramu

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

Príklad: Zmena hodiny

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

---

Vymazanie plánovaného skenu

Natrvalo vymaže plánovaný sken a jeho základný harmonogram.

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

WARNING

Automatický sken podľa plánu (id: "plan") nie je možné vymazať cez API.

Príklad požiadavky

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

Príklad odpovede

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