API atsauce

Aether365 API ļauj programmatiski piekļūt skenēsanas datiem, aktivizēt skenēsanas un vadīt AI Pilot - ģenerēt, pārskatīt un piemērot automātiskas remediācijas, lasīt identitātes riska signālus un nostiprināt politikas.

Galapunktu grupas

Joma	Ko tā aptver
Skenēšanas	Aktivizēt un uzskaitīt atbilstības un riska skenēšanas
Rezultāti	Lasīt atsevišķus skenēšanas atradumus
AI Pilot	Ģenerēt, pārskatīt un piemērot automātiskos remediācijas plānus
Threat Alerts	Identitātes riska signāli un viena klikšķa lietotāja izolēšana
Politikas	Lasīt politiku stāvokli un nostiprināt atļautās politikas
Nomnieki	Lasīt un atjaunināt nomnieka profilu
Savienojumi	Pārvaldīt pieslēgtos Microsoft 365 nomniekus
Plānotās skenēšanas	Automatizēt periodiskās skenēšanas

Bāzes URL

https://api.aether365.io

Visi galapunkti ir relatīvi pret šo bāzes URL.

Autentifikācija

API izmanto Bearer tokenu autentifikāciju. Iekļaujiet derīgu JWT tokenu Authorization galvenē katrā pieprasījumā:

Authorization: Bearer <token>

Tokenus izsniedz Aether365 autentifikācijas sistēma. Skatiet Autentifikācija, lai uzzinātu, kā iegūt tokenu.

Atbilzu formāts

Visas API atbildes izmanto konsekventu JSON struktūru.

Veiksmīga atbilde

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

Saraksta galapunktiem:

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

Darbību galapunktiem (aktivizēsana, dzēsana):

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

Kļūdas atbilde

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

HTTP statusa kodi

Kods	Nozīme
200	Veiksmīgi
201	Resurss izveidots
400	Nederīgs pieprasījums - trūkstosi vai nepareizi parametri
401	Nepieciesama autentifikācija vai tokens nederīgs
403	Piekļuve liegta - nomnieku izolācijas pārkāpums
404	Resurss nav atrasts
409	Konflikts - piemēram, skenēsana jau darbojas
429	Plāna limits sasniegts
500	Iekšēja servera kļūda

Kļūdu kodi

Kods	Apraksts
AUTH_MISSING_TOKEN	Authorization galvene nav iekļauta
AUTH_INVALID_TOKEN	Tokenu nevar verificēt
AUTH_EXPIRED_TOKEN	Tokens ir beidzies
TENANT_NOT_FOUND	Nomnieks nepastāv
TENANT_NOT_CONNECTED	Microsoft piekrišana nav pabeigta
SCAN_NOT_FOUND	Skenēsanas ID nepastāv
SCAN_ALREADY_RUNNING	Skenēsana jau ir procesā sim nomniekam
SCAN_PLAN_LIMIT_REACHED	Skenēsanas kvota pasreizējam plānam izsmeltas
VALIDATION_ERROR	Pieprasījuma pamatteksts vai vaicājuma parametri ir nederīgi
INTERNAL_ERROR	Negaidīta servera kļūda

Ātruma ierobezojumi

API ātruma ierobezojums ir 120 pieprasījumi minūtē. Pārsniedzot ātruma ierobezojumu, tiek atgriezta 429 Too Many Requests atbilde. Retry-After galvene norāda, cik sekundes jāgaida pirms atkārtotas mēģināsanas.