Ieplānoto skenēšanu API

Ieplānotās skenēšanas definē periodiskus skenēšanas uzdevumus. Katra ieplānotā skenēšana definē periodisku aktivizētāju, kas izpildās konfigurētajā intervālā.

Ieplānoto skenēšanu saraksts

Atgriež visas ieplānotās skenēšanas autentificētajam nomniekam, ieskaitot automātisko plāna skenēšanu.

GET /tenants/me/scheduled-scans

Pieprasījuma piemērs

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

Atbildes piemērs

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

Atbildes lauki

Lauks	Tips	Apraksts
id	string	Grafika identifikators ("plan" automātiskajam plāna grafikam)
isPlanSchedule	boolean	true, ja šī ir automātiskā plāna skenēšana
name	string	Attēlošanas nosaukums
frequency	string	daily, weekly vai monthly
hour	integer	Aktivizēšanas stunda (0-23)
minute	integer	Aktivizēšanas minūte (0-59)
dayOfWeek	integer	Nedēļas diena iknedēļas grafikiem (0=Pirmd, 6=Svētd)
dayOfMonth	integer	Mēneša diena ikmēneša grafikiem (1-31)
timezone	string	IANA laika zonas virkne
enabled	boolean	Vai grafiks ir aktīvs
scanType	string	compliance vai exposure
lastTriggeredAt	string vai null	ISO 8601 pēdējā aktivizēšanas laikspiedols

---

Izveidot ieplānoto skenēšanu

Izveido jaunu ieplānoto skenēšanu.

POST /tenants/me/scheduled-scans

Pieprasījuma pamatteksts

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

Lauks	Tips	Obligāts	Apraksts
name	string	Jā	Attēlošanas nosaukums
frequency	string	Jā	daily, weekly vai monthly
hour	integer	Jā	0-23
minute	integer	Jā	0-59
dayOfWeek	integer	Iknedēļas	0=Pirmd, 6=Svētd
dayOfMonth	integer	Ikmēneša	1-31
timezone	string	Jā	IANA laika zona (piemēram, UTC, Europe/Berlin)
scanType	string	Jā	compliance vai exposure
enabled	boolean	Nē	Noklusējums ir true

Pieprasījuma piemērs

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

Kļūdas

Kods	HTTP	Apraksts
SCAN_PLAN_LIMIT_REACHED	429	Pielāgoto grafiku limits jūsu plānam ir sasniegts
VALIDATION_ERROR	400	Trūkstoši vai nederīgi lauki

---

Atjaunināt ieplānoto skenēšanu

Atjaunina esošu ieplānoto skenēšanu. Tiek atjaunināti tikai tie lauki, kurus iekļaujat.

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

Piemērs: apturēt grafiku

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

Piemērs: mainīt stundu

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

---

Dzēst ieplānoto skenēšanu

Neatgriezeniski dzēš ieplānoto skenēšanu un tās pamatā esošo grafiku.

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

WARNING

Automātisko plāna skenēšanu (id: "plan") nevar dzēst caur API.

Pieprasījuma piemērs

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

Atbildes piemērs

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