Skip to content

API za načrtovana skeniranja

Načrtovana skeniranja določajo ponavljajoče se naloge skeniranja. Vsako načrtovano skeniranje definira ponavljajoči se sprožilec, ki se izvede v nastavljenem intervalu.

Seznam načrtovanih skeniranj

Vrne vsa načrtovana skeniranja za overjenega najemnika, vključno s samodejnim skeniranjem paketa.

GET /tenants/me/scheduled-scans

Primer zahteve

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

Primer odgovora

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

Polja odgovora

PoljeVrstaOpis
idstringIdentifikator razporeda ("plan" za samodejni razpored paketa)
isPlanSchedulebooleantrue, če gre za samodejno skeniranje paketa
namestringPrikazno ime
frequencystringdaily, weekly ali monthly
hourintegerUra dneva za sprožitev (0-23)
minuteintegerMinuta ure za sprožitev (0-59)
dayOfWeekintegerDan v tednu za tedenske razporede (0=pon, 6=ned)
dayOfMonthintegerDan v mesecu za mesečne razporede (1-31)
timezonestringČasovni pas IANA
enabledbooleanAli je razpored aktiven
scanTypestringcompliance ali exposure
lastTriggeredAtstring ali nullČasovni žig ISO 8601 zadnje sprožitve

Ustvarjanje načrtovanega skeniranja

Ustvari novo načrtovano skeniranje.

POST /tenants/me/scheduled-scans

Telo zahteve

json
{
  "name": "Monthly exposure scan",
  "frequency": "monthly",
  "hour": 3,
  "minute": 0,
  "dayOfMonth": 1,
  "timezone": "UTC",
  "scanType": "exposure",
  "enabled": true
}
PoljeVrstaZahtevanoOpis
namestringDaPrikazno ime
frequencystringDadaily, weekly ali monthly
hourintegerDa0-23
minuteintegerDa0-59
dayOfWeekintegerZa tedensko0=pon, 6=ned
dayOfMonthintegerZa mesečno1-31
timezonestringDaČasovni pas IANA (npr. UTC, Europe/Berlin)
scanTypestringDacompliance ali exposure
enabledbooleanNePrivzeto true

Primer zahteve

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

Napake

KodaHTTPOpis
SCAN_PLAN_LIMIT_REACHED429Omejitev razporedov po meri za vaš paket je dosežena
VALIDATION_ERROR400Manjkajoča ali neveljavna polja

Posodobitev načrtovanega skeniranja

Posodobi obstoječe načrtovano skeniranje. Posodobljena so samo polja, ki jih vključite.

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

Primer: Zaustavitev razporeda

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

Primer: Sprememba ure

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

Brisanje načrtovanega skeniranja

Trajno izbriše načrtovano skeniranje in njegov pripadajoči razpored.

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

WARNING

Samodejnega skeniranja paketa (id: "plan") ni mogoče izbrisati prek API.

Primer zahteve

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

Primer odgovora

json
{
  "success": true,
  "data": null
}
Je bila ta stran uporabna?