Ajastatud skaneerimiste API

Ajastatud skaneerimised määravad korduvad skaneerimistööd. Iga ajastatud skaneerimine defineerib korduva käivitaja, mis rakendub seadistatud intervalliga.

Ajastatud skaneerimiste loetelu

Tagastab kõik autenditud halduskeskkonna ajastatud skaneerimised, sealhulgas automaatse plaaniskaneerimise.

GET /tenants/me/scheduled-scans

Näidispäring

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

Näidisvastus

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

Vastuse väljad

Väli	Tüüp	Kirjeldus
id	string	Ajakava identifikaator ("plan" automaatse plaaniajakava jaoks)
isPlanSchedule	boolean	true, kui tegemist on automaatse plaaniskaneerimisega
name	string	Kuvatav nimi
frequency	string	daily, weekly või monthly
hour	integer	Käivitamise tund (0-23)
minute	integer	Käivitamise minut (0-59)
dayOfWeek	integer	Nädalapäev iganädalaste ajakavade jaoks (0=E, 6=P)
dayOfMonth	integer	Kuupäev igakuiste ajakavade jaoks (1-31)
timezone	string	IANA ajavööndi string
enabled	boolean	Kas ajakava on aktiivne
scanType	string	compliance või exposure
lastTriggeredAt	string või null	Viimase käivitamise ISO 8601 ajatempel

---

Ajastatud skaneerimise loomine

Loob uue ajastatud skaneerimise.

POST /tenants/me/scheduled-scans

Päringu keha

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

Väli	Tüüp	Nõutav	Kirjeldus
name	string	Jah	Kuvatav nimi
frequency	string	Jah	daily, weekly või monthly
hour	integer	Jah	0-23
minute	integer	Jah	0-59
dayOfWeek	integer	Iganädalane	0=E, 6=P
dayOfMonth	integer	Igakuine	1-31
timezone	string	Jah	IANA ajavöönd (nt UTC, Europe/Berlin)
scanType	string	Jah	compliance või exposure
enabled	boolean	Ei	Vaikimisi true

Näidispäring

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

Vead

Kood	HTTP	Kirjeldus
SCAN_PLAN_LIMIT_REACHED	429	Kohandatud ajakavade limiit on teie plaani jaoks täis
VALIDATION_ERROR	400	Puuduvad või vigased väljad

---

Ajastatud skaneerimise uuendamine

Uuendab olemasolevat ajastatud skaneerimist. Uuendatakse ainult kaasatud välju.

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

Näide: ajakava peatamine

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

Näide: tunni muutmine

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

---

Ajastatud skaneerimise kustutamine

Kustutab ajastatud skaneerimise ja selle aluseks oleva ajakava jäädavalt.

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

WARNING

Automaatset plaaniskaneerimist (id: "plan") ei saa API kaudu kustutada.

Näidispäring

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

Näidisvastus

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