API plánovaných skenů

Plánované skeny definují opakované skenovací úlohy. Každý plánovaný sken definuje opakovanou aktivaci, která se spouští v nastaveném intervalu.

Seznam plánovaných skenů

Vrací všechny plánované skeny pro autentizovaného tenanta, včetně automatického skenu tarifu.

GET /tenants/me/scheduled-scans

Příklad požadavku

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

Příklad odpovědi

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

Pole odpovědi

Pole	Typ	Popis
id	string	Identifikátor plánu ("plan" pro automatický sken tarifu)
isPlanSchedule	boolean	true pokud se jedná o automatický sken tarifu
name	string	Zobrazovaný název
frequency	string	daily, weekly nebo monthly
hour	integer	Hodina spuštění (0-23)
minute	integer	Minuta spuštění (0-59)
dayOfWeek	integer	Den v týdnu pro týdenní plány (0=Po, 6=Ne)
dayOfMonth	integer	Den v měsíci pro měsíční plány (1-31)
timezone	string	Časové pásmo IANA
enabled	boolean	Zda je plán aktivní
scanType	string	compliance nebo exposure
lastTriggeredAt	string nebo null	Časové razítko ISO 8601 posledního spuštění

---

Vytvoření plánovaného skenu

Vytvoří nový plánovaný sken.

POST /tenants/me/scheduled-scans

Tělo požadavku

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

Pole	Typ	Povinné	Popis
name	string	Ano	Zobrazovaný název
frequency	string	Ano	daily, weekly nebo monthly
hour	integer	Ano	0-23
minute	integer	Ano	0-59
dayOfWeek	integer	Pro weekly	0=Po, 6=Ne
dayOfMonth	integer	Pro monthly	1-31
timezone	string	Ano	Časové pásmo IANA (např. UTC, Europe/Berlin)
scanType	string	Ano	compliance nebo exposure
enabled	boolean	Ne	Výchozí hodnota true

Příklad požadavku

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	Dosažen limit vlastních plánů pro váš tarif
VALIDATION_ERROR	400	Chybějící nebo neplatná pole

---

Aktualizace plánovaného skenu

Aktualizuje existující plánovaný sken. Změní se pouze pole, která uvedete.

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

Příklad: Pozastavení plánu

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

Příklad: Změna 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}'

---

Smazání plánovaného skenu

Trvale smaže plánovaný sken a jeho podkladový rozvrh.

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

WARNING

Automatický sken tarifu (id: "plan") nelze smazat přes API.

Příklad požadavku

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

Příklad odpovědi

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