Ütemezett vizsgálatok API

Az ütemezett vizsgálatok ismétlődő vizsgálati feladatokat határoznak meg. Minden ütemezett vizsgálat egy ismétlődő triggert határoz meg, amely a beállított időközben aktiválódik.

Ütemezett vizsgálatok listázása

Az autentikált bérlő összes ütemezett vizsgálatát adja vissza, beleértve az automatikus csomag vizsgálatot.

GET /tenants/me/scheduled-scans

Példa kérés

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

Példa válasz

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

Válasz mezők

Mező	Típus	Leírás
id	string	Ütemezés-azonosító ("plan" az automatikus csomag ütemezéshez)
isPlanSchedule	boolean	true, ha ez az automatikus csomag vizsgálat
name	string	Megjelenítési név
frequency	string	daily, weekly vagy monthly
hour	integer	Aktiválási óra (0-23)
minute	integer	Aktiválási perc (0-59)
dayOfWeek	integer	Hét napja heti ütemezéseknél (0=Hét, 6=Vas)
dayOfMonth	integer	Hónap napja havi ütemezéseknél (1-31)
timezone	string	IANA időzóna karakterlánc
enabled	boolean	Aktív-e az ütemezés
scanType	string	compliance vagy exposure
lastTriggeredAt	string vagy null	Utolsó aktiválás ISO 8601 időbélyegje

---

Ütemezett vizsgálat létrehozása

Új ütemezett vizsgálatot hoz létre.

POST /tenants/me/scheduled-scans

Kéréstörzs

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

Mező	Típus	Kötelező	Leírás
name	string	Igen	Megjelenítési név
frequency	string	Igen	daily, weekly vagy monthly
hour	integer	Igen	0-23
minute	integer	Igen	0-59
dayOfWeek	integer	Hetinél	0=Hét, 6=Vas
dayOfMonth	integer	Havinál	1-31
timezone	string	Igen	IANA időzóna (pl. UTC, Europe/Berlin)
scanType	string	Igen	compliance vagy exposure
enabled	boolean	Nem	Alapértelmezetten true

Példa kérés

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

Hibák

Kód	HTTP	Leírás
SCAN_PLAN_LIMIT_REACHED	429	Az egyedi ütemezés-limit elérve a csomagodban
VALIDATION_ERROR	400	Hiányzó vagy érvénytelen mezők

---

Ütemezett vizsgálat frissítése

Meglévő ütemezett vizsgálatot frissít. Csak a megadott mezők frissülnek.

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

Példa: Ütemezés szüneteltetése

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élda: Óra módosítása

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

---

Ütemezett vizsgálat törlése

Véglegesen törli az ütemezett vizsgálatot és az alapul szolgáló ütemezést.

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

WARNING

Az automatikus csomag vizsgálat (id: "plan") nem törölhető az API-n keresztül.

Példa kérés

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

Példa válasz

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