Suplanuotų nuskaitymų API

Autorius: Aether365 komanda Auditorija: Kūrėjai Apimtis: Suplanuotų nuskaitymų API galutiniai taškai - nuskaitymų tvarkaraščių kūrimas ir valdymas

Suplanuoti nuskaitymai apibrėžia pasikartojančias nuskaitymo užduotis. Kiekvienas suplanuotas nuskaitymas apibrėžia pasikartojantį paleidiklį, kuris suveikia nustatytu intervalu.

Suplanuotų nuskaitymų sąrašas

Grąžina visus autentifikuotos organizacijos suplanuotus nuskaitymus, įskaitant automatinį plano nuskaitymą.

GET /tenants/me/scheduled-scans

Užklausos pavyzdys

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

Atsakymo pavyzdys

{
  "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": "Custom compliance scan",
      "frequency": "weekly",
      "hour": 6,
      "minute": 0,
      "dayOfWeek": 3,
      "dayOfMonth": null,
      "timezone": "Europe/London",
      "enabled": true,
      "scanType": "compliance",
      "lastTriggeredAt": "2026-04-09T06:00:00Z"
    }
  ]
}

Atsakymo laukai

Laukas	Tipas	Aprašymas
id	string	Tvarkaraščio identifikatorius ("plan" automatiniam plano tvarkaraščiui)
isPlanSchedule	boolean	true, jei tai automatinis plano nuskaitymas
name	string	Rodomas pavadinimas
frequency	string	daily, weekly arba monthly
hour	integer	Paleidimo valanda (0-23)
minute	integer	Paleidimo minutė (0-59)
dayOfWeek	integer	Savaitės diena savaitiniams tvarkaraščiams (0=Pirm, 6=Sekm)
dayOfMonth	integer	Mėnesio diena mėnesiniams tvarkaraščiams (1-31)
timezone	string	IANA laiko zonos eilutė
enabled	boolean	Ar tvarkaraštis yra aktyvus
scanType	string	compliance
lastTriggeredAt	string arba null	ISO 8601 paskutinio paleidimo laiko žymė

---

Suplanuoto nuskaitymo kūrimas

Sukuria naują suplanuotą nuskaitymą.

POST /tenants/me/scheduled-scans

Užklausos turinys

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

Laukas	Tipas	Būtinas	Aprašymas
name	string	Taip	Rodomas pavadinimas
frequency	string	Taip	daily, weekly arba monthly
hour	integer	Taip	0-23
minute	integer	Taip	0-59
dayOfWeek	integer	Savaitiniams	0=Pirm, 6=Sekm
dayOfMonth	integer	Mėnesiniams	1-31
timezone	string	Taip	IANA laiko zona (pvz., UTC, Europe/Berlin)
scanType	string	Taip	compliance
enabled	boolean	Ne	Numatytoji reikšmė true

Užklausos pavyzdys

curl -X POST https://api.aether365.io/tenants/me/scheduled-scans \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Custom compliance scan",
    "frequency": "monthly",
    "hour": 3,
    "minute": 0,
    "dayOfMonth": 1,
    "timezone": "UTC",
    "scanType": "compliance",
    "enabled": true
  }'

Klaidos

Kodas	HTTP	Aprašymas
SCAN_PLAN_LIMIT_REACHED	403	Pasirinktiniai tvarkaraščiai reikalauja mokamo plano
SCAN_PLAN_LIMIT_REACHED	429	Pasiektas pasirinktinių tvarkaraščių limitas jūsų planui
VALIDATION_ERROR	400	Trūkstami arba neteisingi laukai

---

Suplanuoto nuskaitymo atnaujinimas

Atnaujina esamą suplanuotą nuskaitymą. Atnaujinami tik tie laukai, kuriuos įtraukiate.

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

Pavyzdys: tvarkaraščio pristabdymas

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

Pavyzdys: valandos keitimas

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

---

Suplanuoto nuskaitymo trynimas

Visam laikui ištrina suplanuotą nuskaitymą ir jo tvarkaraštį.

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

WARNING

Automatinio plano nuskaitymo (id: "plan") negalima ištrinti per API.

Užklausos pavyzdys

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

Atsakymo pavyzdys

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