API Scansioni pianificate

Maintainer: Aether365 Team Destinatari: Sviluppatori Ambito: Endpoint API Scansioni pianificate - creazione e gestione delle pianificazioni

Le scansioni pianificate definiscono job di scansione ricorrenti. Ogni scansione pianificata definisce un trigger ricorrente che si attiva all'intervallo configurato.

Elencare le scansioni pianificate

Restituisce tutte le scansioni pianificate per il tenant autenticato, inclusa la scansione automatica del piano.

GET /tenants/me/scheduled-scans

Richiesta di esempio

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

Risposta di esempio

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

Campi della risposta

Campo	Tipo	Descrizione
id	string	Identificativo della pianificazione ("plan" per quella automatica)
isPlanSchedule	boolean	true se è la scansione automatica del piano
name	string	Nome visualizzato
frequency	string	daily, weekly o monthly
hour	integer	Ora del giorno per l'attivazione (0-23)
minute	integer	Minuto dell'ora per l'attivazione (0-59)
dayOfWeek	integer	Giorno della settimana per pianificazioni settimanali (0=Lun, 6=Dom)
dayOfMonth	integer	Giorno del mese per pianificazioni mensili (1-31)
timezone	string	Stringa fuso orario IANA
enabled	boolean	Se la pianificazione è attiva
scanType	string	compliance o exposure
lastTriggeredAt	string o null	Timestamp ISO 8601 dell'ultima attivazione

---

Creare una scansione pianificata

Crea una nuova scansione pianificata.

POST /tenants/me/scheduled-scans

Corpo della richiesta

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

Campo	Tipo	Obbligatorio	Descrizione
name	string	Sì	Nome visualizzato
frequency	string	Sì	daily, weekly o monthly
hour	integer	Sì	0-23
minute	integer	Sì	0-59
dayOfWeek	integer	Per settimanale	0=Lun, 6=Dom
dayOfMonth	integer	Per mensile	1-31
timezone	string	Sì	Fuso orario IANA (es. UTC, Europe/Berlin)
scanType	string	Sì	compliance o exposure
enabled	boolean	No	Predefinito true

Richiesta di esempio

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

Errori

Codice	HTTP	Descrizione
SCAN_PLAN_LIMIT_REACHED	429	Limite pianificazioni personalizzate raggiunto per il piano
VALIDATION_ERROR	400	Campi mancanti o non validi

---

Aggiornare una scansione pianificata

Aggiorna una scansione pianificata esistente. Vengono aggiornati solo i campi inclusi nella richiesta.

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

Esempio: Mettere in pausa una pianificazione

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

Esempio: Cambiare l'ora

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

---

Eliminare una scansione pianificata

Elimina permanentemente una scansione pianificata e la relativa programmazione.

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

WARNING

La scansione automatica del piano (id: "plan") non può essere eliminata tramite API.

Richiesta di esempio

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

Risposta di esempio

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