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-scansPrimer 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
| Polje | Vrsta | Opis |
|---|---|---|
id | string | Identifikator razporeda ("plan" za samodejni razpored paketa) |
isPlanSchedule | boolean | true, če gre za samodejno skeniranje paketa |
name | string | Prikazno ime |
frequency | string | daily, weekly ali monthly |
hour | integer | Ura dneva za sprožitev (0-23) |
minute | integer | Minuta ure za sprožitev (0-59) |
dayOfWeek | integer | Dan v tednu za tedenske razporede (0=pon, 6=ned) |
dayOfMonth | integer | Dan v mesecu za mesečne razporede (1-31) |
timezone | string | Časovni pas IANA |
enabled | boolean | Ali je razpored aktiven |
scanType | string | compliance ali exposure |
lastTriggeredAt | string ali null | Časovni žig ISO 8601 zadnje sprožitve |
Ustvarjanje načrtovanega skeniranja
Ustvari novo načrtovano skeniranje.
POST /tenants/me/scheduled-scansTelo zahteve
json
{
"name": "Monthly exposure scan",
"frequency": "monthly",
"hour": 3,
"minute": 0,
"dayOfMonth": 1,
"timezone": "UTC",
"scanType": "exposure",
"enabled": true
}| Polje | Vrsta | Zahtevano | Opis |
|---|---|---|---|
name | string | Da | Prikazno ime |
frequency | string | Da | daily, weekly ali monthly |
hour | integer | Da | 0-23 |
minute | integer | Da | 0-59 |
dayOfWeek | integer | Za tedensko | 0=pon, 6=ned |
dayOfMonth | integer | Za mesečno | 1-31 |
timezone | string | Da | Časovni pas IANA (npr. UTC, Europe/Berlin) |
scanType | string | Da | compliance ali exposure |
enabled | boolean | Ne | Privzeto 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
| Koda | HTTP | Opis |
|---|---|---|
SCAN_PLAN_LIMIT_REACHED | 429 | Omejitev razporedov po meri za vaš paket je dosežena |
VALIDATION_ERROR | 400 | Manjkajoč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
}