Scheduled Scans API

Betreut von: Aether365 Team Zielgruppe: Entwickler Umfang: API-Endpunkte für geplante Scans - Scan-Zeitpläne erstellen und verwalten

Geplante Scans definieren wiederkehrende Scan-Aufträge. Jeder geplante Scan legt einen wiederkehrenden Auslöser fest, der im konfigurierten Intervall ausgeführt wird.

Geplante Scans auflisten

Gibt alle geplanten Scans für den authentifizierten Tenant zurück, einschließlich des automatischen Plan-Scans.

GET /tenants/me/scheduled-scans

Beispielanfrage

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

Beispielantwort

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

Antwortfelder

Feld	Typ	Beschreibung
id	string	Zeitplan-Kennung ("plan" für den automatischen Plan-Scan)
isPlanSchedule	boolean	true, wenn es sich um den automatischen Plan-Scan handelt
name	string	Anzeigename
frequency	string	daily, weekly oder monthly
hour	integer	Auslösestunde (0-23)
minute	integer	Auslöseminute (0-59)
dayOfWeek	integer	Wochentag für wöchentliche Zeitpläne (0=Mo, 6=So)
dayOfMonth	integer	Tag des Monats für monatliche Zeitpläne (1-31)
timezone	string	IANA-Zeitzonenbezeichnung
enabled	boolean	Ob der Zeitplan aktiv ist
scanType	string	compliance oder exposure
lastTriggeredAt	string oder null	ISO 8601-Zeitstempel der letzten Auslösung

---

Geplanten Scan erstellen

Erstellt einen neuen geplanten Scan.

POST /tenants/me/scheduled-scans

Anfragekörper

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

Feld	Typ	Erforderlich	Beschreibung
name	string	Ja	Anzeigename
frequency	string	Ja	daily, weekly oder monthly
hour	integer	Ja	0-23
minute	integer	Ja	0-59
dayOfWeek	integer	Für weekly	0=Mo, 6=So
dayOfMonth	integer	Für monthly	1-31
timezone	string	Ja	IANA-Zeitzone (z.B. UTC, Europe/Berlin)
scanType	string	Ja	compliance oder exposure
enabled	boolean	Nein	Standard: true

Beispielanfrage

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

Fehler

Code	HTTP	Beschreibung
SCAN_PLAN_LIMIT_REACHED	429	Limit für benutzerdefinierte Zeitpläne im Plan erreicht
VALIDATION_ERROR	400	Fehlende oder ungültige Felder

---

Geplanten Scan aktualisieren

Aktualisiert einen bestehenden geplanten Scan. Nur die angegebenen Felder werden geändert.

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

Beispiel: Zeitplan pausieren

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

Beispiel: Uhrzeit ändern

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

---

Geplanten Scan löschen

Löscht einen geplanten Scan und den zugehörigen Zeitplan dauerhaft.

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

WARNING

Der automatische Plan-Scan (id: "plan") kann nicht über die API gelöscht werden.

Beispielanfrage

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

Beispielantwort

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