Skip to content

API hivatkozás

Az Aether365 API lehetővé teszi a vizsgálati adatok programozott elérését, vizsgálatok indítását, bérlők kezelését és az AI Pilot vezérlését: automatizált javítás generálását, áttekintését és alkalmazását, identitáskockázati jelzések olvasását és szabályzatok megerősítését.

Végpontcsoportok

TerületMit fed le
ScansMegfelelőségi és kitettségi vizsgálatok indítása és listázása
ResultsEgyes vizsgálati megállapítások olvasása
AI PilotAutomatizált javítási tervek generálása, áttekintése és alkalmazása
Threat AlertsIdentitáskockázati jelzések és egykattintásos felhasználó-elszigetelés
PoliciesSzabályzatállapot olvasása és engedélyezett szabályzatok megerősítése
TenantsBérlőprofil olvasása és frissítése
ConnectionsÖsszekapcsolt Microsoft 365 bérlők kezelése
Scheduled ScansIsmétlődő vizsgálatok automatizálása

Alap URL

https://api.aether365.io

Minden végpont ehhez az alap URL-hez relatív.

Hitelesítés

Az API Bearer token hitelesítést használ. Mellékelj érvényes JWT tokent az Authorization fejléchez minden kérésnél:

Authorization: Bearer <token>

A tokeneket az Aether365 hitelesítési rendszere állítja ki. Lásd: Hitelesítés a token megszerzésének részleteiért.

Válasz formátum

Minden API válasz egységes JSON struktúrát használ.

Sikeres válasz

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

Lista végpontoknál:

json
{
  "success": true,
  "data": [],
  "meta": {
    "total": 142,
    "page": 1,
    "limit": 20
  }
}

Művelet végpontoknál (indít, töröl):

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

Hibaválasz

json
{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Ember által olvasható leírás",
    "details": {}
  }
}

HTTP állapotkódok

KódJelentés
200Sikeres
201Erőforrás létrehozva
400Érvénytelen kérés - hiányzó vagy hibás paraméterek
401Hitelesítés szükséges vagy token érvénytelen
403Hozzáférés megtagadva - bérlő izoláció sértés
404Erőforrás nem található
409Konfliktus - például egy vizsgálat már fut
429Csomag limit elérve
500Belső szerverhiba

Hibakódok

KódLeírás
AUTH_MISSING_TOKENAuthorization fejléc nincs jelen
AUTH_INVALID_TOKENA token nem ellenőrizhető
AUTH_EXPIRED_TOKENA token lejárt
TENANT_NOT_FOUNDA bérlő nem létezik
TENANT_NOT_CONNECTEDA Microsoft consent nincs befejezve
SCAN_NOT_FOUNDA vizsgálat-azonosító nem létezik
SCAN_ALREADY_RUNNINGEgy vizsgálat már folyamatban van ehhez a bérlőhöz
SCAN_PLAN_LIMIT_REACHEDA vizsgálati kvóta kimerült az aktuális csomagban
VALIDATION_ERRORA kéréstörzs vagy lekérdezési paraméterek érvénytelenek
INTERNAL_ERRORVáratlan szerverhiba

Sebességkorlátozás

Az API percenként 120 kérésre korlátozott. A korlátot meghaladó kérésekre 429 Too Many Requests a válasz. A Retry-After fejléc jelzi, hány másodpercet kell várni az újrapróbálás előtt.

Hasznos volt ez az oldal?