Skip to content

API referencia

Aether365 API umožňuje programovo pristupovať k dátam skenov, spúšťať skeny, spravovať tenantov a riadiť AI Pilot: generovať, kontrolovať a aplikovať automatizovanú nápravu, čítať signály rizika identity a spevňovať politiky.

Skupiny koncových bodov

OblasťČo pokrýva
ScansSpúšťanie a zoznam skenov zhody a expozície
ResultsČítanie jednotlivých zistení skenu
AI PilotGenerovanie, kontrola a aplikovanie plánov automatizovanej nápravy
Threat AlertsSignály rizika identity a zadržanie používateľa jedným kliknutím
PoliciesČítanie stavu politík a spevnenie politík na zozname povolených
TenantsČítanie a aktualizácia profilu tenanta
ConnectionsSpráva pripojených tenantov Microsoft 365
Scheduled ScansAutomatizácia opakovaných skenov

Základná URL

https://api.aether365.io

Všetky koncové body sú relatívne k tejto základnej URL.

Autentifikácia

API používa autentifikáciu pomocou Bearer tokenu. Do hlavičky Authorization každej požiadavky zahrňte platný JWT token:

Authorization: Bearer <token>

Tokeny vydáva autentifikačný systém Aether365. Podrobnosti o získaní tokenu nájdete v časti Autentifikácia.

Formát odpovedí

Všetky odpovede API používajú konzistentný formát JSON.

Úspešná odpoveď

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

Pre výpisové koncové body:

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

Pre akčné koncové body (spustenie, vymazanie):

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

Chybová odpoveď

json
{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable description",
    "details": {}
  }
}

HTTP stavové kódy

KódVýznam
200Úspech
201Zdroj vytvorený
400Neplatná požiadavka - chýbajúce alebo chybné parametre
401Vyžaduje sa autentifikácia alebo neplatný token
403Prístup zamietnutý - porušenie izolácie tenantu
404Zdroj nenájdený
409Konflikt - napríklad sken už beží
429Dosiahnutý limit plánu
500Interná chyba servera

Chybové kódy

KódPopis
AUTH_MISSING_TOKENHlavička Authorization nie je prítomná
AUTH_INVALID_TOKENToken sa nepodarilo overiť
AUTH_EXPIRED_TOKENPlatnosť tokenu vypršala
TENANT_NOT_FOUNDTenant neexistuje
TENANT_NOT_CONNECTEDMicrosoft súhlas nebol dokončený
SCAN_NOT_FOUNDID skenu neexistuje
SCAN_ALREADY_RUNNINGPre tohto tenanta už beží sken
SCAN_PLAN_LIMIT_REACHEDKvóta skenov pre aktuálny plán je vyčerpaná
VALIDATION_ERRORTelo požiadavky alebo parametre dopytu sú neplatné
INTERNAL_ERRORNeočakávaná chyba servera

Limity rýchlosti

API je limitované na 120 požiadaviek za minútu. Prekročenie limitu vráti odpoveď 429 Too Many Requests. Hlavička Retry-After udáva, koľko sekúnd treba počkať pred opakovaním.

Bola táto stránka užitočná?