Scheduled Scans API

Onderhouden door: Aether365 Team Doelgroep: Ontwikkelaars Scope: Scheduled Scans API endpoints - scanschema's aanmaken en beheren

Geplande scans definieren terugkerende scantaken. Elk gepland schema definieert een terugkerende trigger die wordt afgevuurd op het geconfigureerde interval.

Geplande scans ophalen

Retourneert alle geplande scans voor de geauthenticeerde tenant, inclusief de automatische abonnementsscan.

GET /tenants/me/scheduled-scans

Voorbeeldverzoek

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

Voorbeeldresponse

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

Responsevelden

Veld	Type	Beschrijving
id	string	Schema-identificatie ("plan" voor het automatische abonnementsschema)
isPlanSchedule	boolean	true als dit de automatische abonnementsscan is
name	string	Weergavenaam
frequency	string	daily, weekly of monthly
hour	integer	Uur van de dag om uit te voeren (0-23)
minute	integer	Minuut van het uur om uit te voeren (0-59)
dayOfWeek	integer	Dag van de week voor wekelijkse schema's (0=Ma, 6=Zo)
dayOfMonth	integer	Dag van de maand voor maandelijkse schema's (1-31)
timezone	string	IANA-tijdzonestring
enabled	boolean	Of het schema actief is
scanType	string	compliance of exposure
lastTriggeredAt	string of null	ISO 8601-tijdstempel van laatste uitvoering

---

Gepland schema aanmaken

Maakt een nieuw gepland schema aan.

POST /tenants/me/scheduled-scans

Verzoekbody

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

Veld	Type	Vereist	Beschrijving
name	string	Ja	Weergavenaam
frequency	string	Ja	daily, weekly of monthly
hour	integer	Ja	0-23
minute	integer	Ja	0-59
dayOfWeek	integer	Bij wekelijks	0=Ma, 6=Zo
dayOfMonth	integer	Bij maandelijks	1-31
timezone	string	Ja	IANA-tijdzone (bijv. UTC, Europe/Berlin)
scanType	string	Ja	compliance of exposure
enabled	boolean	Nee	Standaard true

Voorbeeldverzoek

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

Fouten

Code	HTTP	Beschrijving
SCAN_PLAN_LIMIT_REACHED	429	Limiet voor aangepaste schema's bereikt voor je abonnement
VALIDATION_ERROR	400	Ontbrekende of ongeldige velden

---

Gepland schema bijwerken

Werkt een bestaand gepland schema bij. Alleen de meegestuurde velden worden bijgewerkt.

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

Voorbeeld: een schema pauzeren

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

Voorbeeld: het uur wijzigen

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

---

Gepland schema verwijderen

Verwijdert een gepland schema en het onderliggende schema permanent.

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

WARNING

Het automatische abonnementsschema (id: "plan") kan niet via de API worden verwijderd.

Voorbeeldverzoek

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

Voorbeeldresponse

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