API for planlagte skanninger

Vedlikeholdt av: Aether365 Team Malgruppe: Utviklere Omfang: API-endepunkter for planlagte skanninger - opprette og administrere skannetidsplaner

Planlagte skanninger definerer gjentakende skannejobber. Hver planlagt skanning definerer en gjentakende utløser som kjører med det konfigurerte intervallet.

Liste over planlagte skanninger

Returnerer alle planlagte skanninger for den autentiserte leietakeren, inkludert den automatiske plantidsplanen.

GET /tenants/me/scheduled-scans

Eksempelforespørsel

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

Eksempelrespons

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

Responsfelt

Felt	Type	Beskrivelse
id	string	Tidsplanidentifikator ("plan" for den automatiske plantidsplanen)
isPlanSchedule	boolean	true hvis dette er den automatiske planlagte skanningen
name	string	Visningsnavn
frequency	string	daily, weekly eller monthly
hour	integer	Time på dagen for utløsning (0-23)
minute	integer	Minutt for utløsning (0-59)
dayOfWeek	integer	Ukedag for ukentlige tidsplaner (0=man, 6=son)
dayOfMonth	integer	Dag i maneden for manedlige tidsplaner (1-31)
timezone	string	IANA-tidssonestreng
enabled	boolean	Om tidsplanen er aktiv
scanType	string	compliance
lastTriggeredAt	string eller null	ISO 8601-tidsstempel for siste utløsning

---

Opprett planlagt skanning

Oppretter en ny planlagt skanning.

POST /tenants/me/scheduled-scans

Forespørselsbrødtekst

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

Felt	Type	Pakrevd	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 ukentlig	0=man, 6=son
dayOfMonth	integer	For manedlig	1-31
timezone	string	Ja	IANA-tidssone (f.eks. UTC, Europe/Berlin)
scanType	string	Ja	compliance
enabled	boolean	Nei	Standard true

Eksempelforespørsel

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

Feil

Kode	HTTP	Beskrivelse
SCAN_PLAN_LIMIT_REACHED	429	Grensen for egendefinerte tidsplaner er nadd for planen din
VALIDATION_ERROR	400	Manglende eller ugyldige felt

---

Oppdater planlagt skanning

Oppdaterer en eksisterende planlagt skanning. Kun feltene du inkluderer oppdateres.

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

Eksempel: Pause en tidsplan

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

---

Slett planlagt skanning

Sletter permanent en planlagt skanning og dens underliggende tidsplan.

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

WARNING

Den automatiske plantidsplanen (id: "plan") kan ikke slettes via APIet.

Eksempelforespørsel

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

Eksempelrespons

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