API för schemalagda skanningar

Underhålls av: Aether365 Team Målgrupp: Utvecklare Omfattning: API-endpoints för schemalagda skanningar - skapa och hantera skanningsscheman

Schemalagda skanningar definierar återkommande skanningsjobb. Varje schemalagd skanning definierar en återkommande utlösare som aktiveras vid det konfigurerade intervallet.

Lista schemalagda skanningar

Returnerar alla schemalagda skanningar för den autentiserade tenanten, inklusive det automatiska planschemat.

GET /tenants/me/scheduled-scans

Exempelbegäran

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

Exempelsvar

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

Svarsfält

Fält	Typ	Beskrivning
id	string	Schemaidentifierare ("plan" för det automatiska planschemat)
isPlanSchedule	boolean	true om detta är det automatiska planschemat
name	string	Visningsnamn
frequency	string	daily, weekly eller monthly
hour	integer	Timme att utlösa (0-23)
minute	integer	Minut att utlösa (0-59)
dayOfWeek	integer	Veckodag för veckoscheman (0=mån, 6=sön)
dayOfMonth	integer	Dag i månaden för månadsscheman (1-31)
timezone	string	IANA-tidszonsträng
enabled	boolean	Om schemat är aktivt
scanType	string	compliance eller exposure
lastTriggeredAt	string eller null	ISO 8601-tidsstämpel för senaste utlösning

---

Skapa schemalagd skanning

Skapar en ny schemalagd skanning.

POST /tenants/me/scheduled-scans

Begärandekropp

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

Fält	Typ	Obligatoriskt	Beskrivning
name	string	Ja	Visningsnamn
frequency	string	Ja	daily, weekly eller monthly
hour	integer	Ja	0-23
minute	integer	Ja	0-59
dayOfWeek	integer	För weekly	0=mån, 6=sön
dayOfMonth	integer	För monthly	1-31
timezone	string	Ja	IANA-tidszon (t.ex. UTC, Europe/Berlin)
scanType	string	Ja	compliance eller exposure
enabled	boolean	Nej	Standard true

Exempelbegäran

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

Fel

Kod	HTTP	Beskrivning
SCAN_PLAN_LIMIT_REACHED	429	Gräns för anpassade scheman nådd för din plan
VALIDATION_ERROR	400	Saknade eller ogiltiga fält

---

Uppdatera schemalagd skanning

Uppdaterar en befintlig schemalagd skanning. Bara fält du inkluderar uppdateras.

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

Exempel: Pausa ett schema

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

Exempel: Ändra timme

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

---

Radera schemalagd skanning

Raderar permanent en schemalagd skanning och dess underliggande schema.

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

WARNING

Det automatiska planschemat (id: "plan") kan inte raderas via API:et.

Exempelbegäran

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

Exempelsvar

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