API viide

Aether365 API võimaldab programmiliselt ligi pääseda skaneerimisandmetele, käivitada skaneerimisi, hallata halduskeskkondi ning juhtida AI Pilot funktsiooni: genereerida, üle vaadata ja rakendada automaatseid parandusi, lugeda identiteediriski signaale ning karmistada poliitikaid.

Lõpp-punktide rühmad

| Valdkond | Mida hõlmab | | Skaneeringud | Käivita ja loetle vastavus- ja kokkupuuteskaneeringuid | | Tulemused | Loe üksikuid skaneerimisleide | | AI Pilot | Genereeri, vaata üle ja rakenda automaatseid kõrvaldamisplaane | | Threat Alerts | Identiteediriski signaalid ja ühe klõpsuga kasutaja ohjeldamine | | Poliitikad | Loe poliitikate seisu ja karmista lubatud poliitikaid | | Halduskeskkonnad | Loe ja uuenda halduskeskkonna profiili | | Ühendused | Halda seotud Microsoft 365 halduskeskkondi | | Ajastatud skaneeringud | Automatiseeri korduvaid skaneeringuid |

Baas-URL

https://api.aether365.io

Kõik lõpp-punktid on selle baas-URL-i suhtes suhtelised.

Autentimine

API kasutab Bearer tokeni autentimist. Lisage kehtiv JWT token iga päringu Authorization päisesse:

Authorization: Bearer <token>

Tokenid väljastatakse Aether365 autentimissüsteemi poolt. Vaadake Autentimine tokeni saamise üksikasjade jaoks.

Vastuse formaat

Kõik API vastused kasutavad ühtset JSON-struktuuri.

Edukas vastus

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

Loendi lõpp-punktide jaoks:

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

Toimingu lõpp-punktide jaoks (käivitamine, kustutamine):

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

Veavastus

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

HTTP olekukoodid

Kood	Tähendus
200	Edukas
201	Ressurss loodud
400	Vigane päring - puuduvad või vigased parameetrid
401	Autentimine nõutav või token kehtetu
403	Juurdepääs keelatud - halduskeskkonna eraldatuse rikkumine
404	Ressurssi ei leitud
409	Konflikt - näiteks skaneerimine juba käib
429	Plaani piirang saavutatud
500	Serveri sisemine viga

Veakoodid

Kood	Kirjeldus
AUTH_MISSING_TOKEN	Authorization päis puudub
AUTH_INVALID_TOKEN	Tokenit ei saanud verifitseerida
AUTH_EXPIRED_TOKEN	Token on aegunud
TENANT_NOT_FOUND	Halduskeskkonda ei eksisteeri
TENANT_NOT_CONNECTED	Microsofti nõusolek pole lõpetatud
SCAN_NOT_FOUND	Skaneerimise ID-d ei eksisteeri
SCAN_ALREADY_RUNNING	Selle halduskeskkonna jaoks on skaneerimine juba käimas
SCAN_PLAN_LIMIT_REACHED	Praeguse plaani skaneerimiskvoot on ammendatud
VALIDATION_ERROR	Päringu keha või pärimisparameetrid on vigased
INTERNAL_ERROR	Ootamatu serveri viga

Kiirusepiirangud

API-l on kiirusepiirang 120 päringut minutis. Kiirusepiirangu ületamisel tagastatakse 429 Too Many Requests. Retry-After päis näitab, mitu sekundit enne uuesti proovimist oodata.