Skip to content

API Scanări programate

Scanările programate definesc joburi de scanare recurente. Fiecare scanare programată definește un declanșator recurent care se activează la intervalul configurat.

Listarea scanărilor programate

Returnează toate scanările programate pentru tenant-ul autentificat, inclusiv scanarea automată a planului.

GET /tenants/me/scheduled-scans

Exemplu de cerere

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

Exemplu de răspuns

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

Câmpuri răspuns

CâmpTipDescriere
idstringIdentificator programare ("plan" pentru scanarea automată a planului)
isPlanSchedulebooleantrue dacă aceasta este scanarea automată a planului
namestringNume afișat
frequencystringdaily, weekly sau monthly
hourintegerOra din zi la care se declanșează (0-23)
minuteintegerMinutul din oră la care se declanșează (0-59)
dayOfWeekintegerZiua din săptămână pentru programări săptămânale (0=Luni, 6=Duminică)
dayOfMonthintegerZiua din lună pentru programări lunare (1-31)
timezonestringFus orar IANA
enabledbooleanDacă programarea este activă
scanTypestringcompliance sau exposure
lastTriggeredAtstring sau nullMarcaj temporal ISO 8601 al ultimei declanșări

Crearea unei scanări programate

Creează o scanare programată nouă.

POST /tenants/me/scheduled-scans

Corp cerere

json
{
  "name": "Monthly exposure scan",
  "frequency": "monthly",
  "hour": 3,
  "minute": 0,
  "dayOfMonth": 1,
  "timezone": "UTC",
  "scanType": "exposure",
  "enabled": true
}
CâmpTipObligatoriuDescriere
namestringDaNume afișat
frequencystringDadaily, weekly sau monthly
hourintegerDa0-23
minuteintegerDa0-59
dayOfWeekintegerPentru weekly0=Luni, 6=Duminică
dayOfMonthintegerPentru monthly1-31
timezonestringDaFus orar IANA (de exemplu, UTC, Europe/Berlin)
scanTypestringDacompliance sau exposure
enabledbooleanNuImplicit true

Exemplu de cerere

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

Erori

CodHTTPDescriere
SCAN_PLAN_LIMIT_REACHED429Limita de programări personalizate atinsă pentru planul dvs.
VALIDATION_ERROR400Câmpuri lipsă sau invalide

Actualizarea unei scanări programate

Actualizează o scanare programată existentă. Doar câmpurile pe care le includeți sunt actualizate.

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

Exemplu: Punerea în pauză a unei programări

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

Exemplu: Schimbarea orei

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

Ștergerea unei scanări programate

Șterge permanent o scanare programată și programarea subiacentă.

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

WARNING

Scanarea automată a planului (id: "plan") nu poate fi ștearsă prin API.

Exemplu de cerere

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

Exemplu de răspuns

json
{
  "success": true,
  "data": null
}
Ți-a fost utilă această pagină?