Referenca API

API vmesnik Aether365 omogoča programski dostop do podatkov skeniranja, sprožanje skeniranj, upravljanje najemnikov in poganjanje AI Pilot - ustvarjanje, pregled in uveljavljanje samodejne odprave napak, branje signalov tveganja identitete in utrjevanje pravilnikov.

Skupine končnih točk

Področje	Kaj pokriva
Skeniranja	Sprožanje in seznam skeniranj skladnosti in izpostavljenosti
Rezultati	Branje posameznih ugotovitev skeniranja
AI Pilot	Ustvarjanje, pregled in uveljavljanje načrtov samodejne odprave napak
Threat Alerts	Signali tveganja identitete in zajezitev uporabnika z enim klikom
Pravilniki	Branje stanja pravilnikov in utrjevanje pravilnikov na seznamu dovoljenih
Najemniki	Branje in posodabljanje profila najemnika
Povezave	Upravljanje povezanih najemnikov Microsoft 365
Načrtovana skeniranja	Avtomatizacija ponavljajočih se skeniranj

Osnovni URL

https://api.aether365.io

Vse končne točke so relativne glede na ta osnovni URL.

Preverjanje pristnosti

API uporablja preverjanje pristnosti z žetonom Bearer. V glavo Authorization vsake zahteve vključite veljaven žeton JWT:

Authorization: Bearer <token>

Žetone izdaja sistem za preverjanje pristnosti Aether365. Glejte Preverjanje pristnosti za podrobnosti o pridobitvi žetona.

Format odgovorov

Vsi odgovori API uporabljajo dosledno strukturo JSON.

Uspešen odgovor

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

Za končne točke s seznami:

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

Za končne točke dejanj (sprožitev, brisanje):

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

Odgovor z napako

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Berljiv opis napake",
    "details": {}
  }
}

Statusne kode HTTP

Koda	Pomen
200	Uspeh
201	Vir ustvarjen
400	Neveljavna zahteva - manjkajoči ali napačni parametri
401	Zahtevano preverjanje pristnosti ali neveljaven žeton
403	Dostop zavrnjen - kršitev izolacije najemnika
404	Vir ne obstaja
409	Konflikt - na primer, skeniranje je že v teku
429	Omejitev paketa dosežena
500	Notranja napaka strežnika

Kode napak

Koda	Opis
AUTH_MISSING_TOKEN	Glava Authorization ni prisotna
AUTH_INVALID_TOKEN	Žetona ni mogoče preveriti
AUTH_EXPIRED_TOKEN	Žeton je potekel
TENANT_NOT_FOUND	Najemnik ne obstaja
TENANT_NOT_CONNECTED	Microsoftovo soglasje ni zaključeno
SCAN_NOT_FOUND	Identifikator skeniranja ne obstaja
SCAN_ALREADY_RUNNING	Skeniranje je že v teku za tega najemnika
SCAN_PLAN_LIMIT_REACHED	Kvota skeniranja za trenutni paket je izčrpana
VALIDATION_ERROR	Telo zahteve ali poizvedbeni parametri so neveljavni
INTERNAL_ERROR	Nepričakovana napaka strežnika

Omejitve hitrosti

API je omejen na 120 zahtev na minuto. Preseganje omejitve vrne 429 Too Many Requests. Glava Retry-After pove, koliko sekund morate počakati pred ponovnim poskusom.