Aikataulutetut skannaukset -API

Ylläpitäjä: Aether365-tiimi Kohderyhmä: Kehittäjät Laajuus: Aikataulutettujen skannausten API-päätepisteet - skannausaikataulujen luominen ja hallinta

Aikataulutetut skannaukset määrittelevät toistuvat skannaustehtävät. Jokainen aikataulutettu skannaus määrittää toistuvan herättimen, joka käynnistyy määritetyin välein.

Listaa aikataulutetut skannaukset

Palauttaa kaikki todennetun vuokralaisen aikataulutetut skannaukset, mukaan lukien automaattisen suunnitelma-skannauksen.

GET /tenants/me/scheduled-scans

Esimerkkipyyntö

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

Esimerkkivastaus

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

Vastauksen kentät

Kenttä	Tyyppi	Kuvaus
id	string	Aikataulun tunniste ("plan" automaattiselle suunnitelma-aikataululle)
isPlanSchedule	boolean	true jos kyseessä on automaattinen suunnitelma-skannaus
name	string	Näyttönimi
frequency	string	daily, weekly tai monthly
hour	integer	Käynnistystunti (0-23)
minute	integer	Käynnistysminuutti (0-59)
dayOfWeek	integer	Viikonpäivä viikoittaisille aikatauluille (0=ma, 6=su)
dayOfMonth	integer	Kuukauden päivä kuukausittaisille aikatauluille (1-31)
timezone	string	IANA-aikavyöhykemerkkijono
enabled	boolean	Onko aikataulu aktiivinen
scanType	string	compliance tai exposure
lastTriggeredAt	string tai null	ISO 8601 -aikaleima viimeisestä käynnistyksestä

---

Luo aikataulutettu skannaus

Luo uuden aikataulutetun skannauksen.

POST /tenants/me/scheduled-scans

Pyynnön runko

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

Kenttä	Tyyppi	Pakollinen	Kuvaus
name	string	Kyllä	Näyttönimi
frequency	string	Kyllä	daily, weekly tai monthly
hour	integer	Kyllä	0-23
minute	integer	Kyllä	0-59
dayOfWeek	integer	Viikoittaisille	0=ma, 6=su
dayOfMonth	integer	Kuukausittaisille	1-31
timezone	string	Kyllä	IANA-aikavyöhyke (esim. UTC, Europe/Berlin)
scanType	string	Kyllä	compliance tai exposure
enabled	boolean	Ei	Oletus: true

Esimerkkipyyntö

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

Virheet

Koodi	HTTP	Kuvaus
SCAN_PLAN_LIMIT_REACHED	429	Mukautettujen aikataulujen raja saavutettu suunnitelmalle
VALIDATION_ERROR	400	Puuttuvat tai virheelliset kentät

---

Päivitä aikataulutettu skannaus

Päivittää olemassa olevan aikataulutetun skannauksen. Vain mukaan otetut kentät päivitetään.

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

Esimerkki: Keskeytä aikataulu

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

Esimerkki: Vaihda tunti

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

---

Poista aikataulutettu skannaus

Poistaa pysyvästi aikataulutetun skannauksen ja sen taustalla olevan aikataulun.

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

WARNING

Automaattista suunnitelma-skannausta (id: "plan") ei voi poistaa API:n kautta.

Esimerkkipyyntö

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

Esimerkkivastaus

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