Planlagte scanninger API

Planlagte scanninger definerer tilbagevendende scanningsjobs. Hver planlagt scanning definerer en tilbagevendende trigger, der aktiveres med det konfigurerede interval.

List planlagte scanninger

Returnerer alle planlagte scanninger for den autentificerede tenant, inklusive den automatiske plantidsplan.

GET /tenants/me/scheduled-scans

Eksempel på forespørgsel

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

Eksempel på svar

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

Svarfelter

Felt	Type	Beskrivelse
id	string	Tidsplanidentifikator ("plan" for den automatiske plantidsplan)
isPlanSchedule	boolean	true hvis dette er den automatiske plantidsplan
name	string	Visningsnavn
frequency	string	daily, weekly eller monthly
hour	integer	Klokkeslæt for udløsning (0-23)
minute	integer	Minut for udløsning (0-59)
dayOfWeek	integer	Ugedag for ugentlige tidsplaner (0=man, 6=søn)
dayOfMonth	integer	Dag i måneden for månedlige tidsplaner (1-31)
timezone	string	IANA-tidszonestreng
enabled	boolean	Om tidsplanen er aktiv
scanType	string	compliance
lastTriggeredAt	string eller null	ISO 8601-tidsstempel for seneste udløsning

---

Opret planlagt scanning

Opretter en ny planlagt scanning.

POST /tenants/me/scheduled-scans

Forespørgselsindhold

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

Felt	Type	Påkrævet	Beskrivelse
name	string	Ja	Visningsnavn
frequency	string	Ja	daily, weekly eller monthly
hour	integer	Ja	0-23
minute	integer	Ja	0-59
dayOfWeek	integer	For ugentlige	0=man, 6=søn
dayOfMonth	integer	For månedlige	1-31
timezone	string	Ja	IANA-tidszone (f.eks. UTC, Europe/Berlin)
scanType	string	Ja	compliance
enabled	boolean	Nej	Standard true

Eksempel på forespørgsel

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

Fejl

Kode	HTTP	Beskrivelse
SCAN_PLAN_LIMIT_REACHED	429	Grænse for brugerdefinerede tidsplaner nået for din plan
VALIDATION_ERROR	400	Manglende eller ugyldige felter

---

Opdater planlagt scanning

Opdaterer en eksisterende planlagt scanning. Kun de felter, du inkluderer, opdateres.

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

Eksempel: Sæt en tidsplan på pause

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

Eksempel: Skift timen

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

---

Slet planlagt scanning

Sletter permanent en planlagt scanning og dens underliggende tidsplan.

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

WARNING

Den automatiske plantidsplan (id: "plan") kan ikke slettes via API'et.

Eksempel på forespørgsel

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

Eksempel på svar

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