API-viite

Ylläpitäjä: Aether365-tiimi Kohderyhmä: Kehittäjät ja DevOps-insinöörit Laajuus: Aether365 REST API:n yleiskatsaus, perus-URL ja vastausmuoto

Aether365 API mahdollistaa skannaustietojen ohjelmallisen käsittelyn, skannausten käynnistämisen, vuokralaisten hallinnan ja AI Pilotin ohjaamisen: automaattisten korjausten luonnin, tarkistuksen ja käyttöönoton, identiteettiriskin signaalien lukemisen sekä käytäntöjen koventamisen.

Päätepisteryhmät

Alue	Mitä se kattaa
Skannaukset	Käynnistä ja listaa vaatimustenmukaisuus- ja altistumisskannaukset
Tulokset	Lue yksittäisiä skannaushavaintoja
AI Pilot	Luo, tarkista ja ota käyttöön automaattisia korjaussuunnitelmia
Threat Alerts	Identiteettiriskin signaalit ja yhden napsautuksen käyttäjän eristäminen
Käytännöt	Lue käytäntöjen tila ja koventa sallitut käytännöt
Vuokralaiset	Lue ja päivitä vuokralaisen profiili
Yhteydet	Hallitse yhdistettyjä Microsoft 365 -vuokralaisia
Ajastetut skannaukset	Automatisoi toistuvat skannaukset

Perus-URL

https://api.aether365.io

Kaikki päätepisteet ovat suhteessa tähän perus-URL:iin.

Todennus

API käyttää Bearer-tokenitodennusta. Lisää kelvollinen JWT-token Authorization-otsikkoon jokaiseen pyyntöön:

Authorization: Bearer <token>

Tokenit myöntää Aether365:n todennusjärjestelmä. Katso Todennus lisätietoja tokenin hankkimisesta.

Vastausmuoto

Kaikki API-vastaukset käyttävät yhdenmukaista JSON-rakennetta.

Onnistunut vastaus

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

Listapäätepisteille:

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

Toimintopäätepisteille (käynnistys, poisto):

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

Virhevastaus

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Ihmisluettava kuvaus",
    "details": {}
  }
}

HTTP-tilakoodit

Koodi	Merkitys
200	Onnistui
201	Resurssi luotu
400	Virheellinen pyyntö - puuttuvat tai väärät parametrit
401	Todennus vaaditaan tai token on virheellinen
403	Pääsy estetty - vuokralaisen eristysloukkaus
404	Resurssia ei löydy
409	Ristiriita - esimerkiksi skannaus on jo käynnissä
429	Suunnitelmaraja saavutettu
500	Sisäinen palvelinvirhe

Virhekoodit

Koodi	Kuvaus
AUTH_MISSING_TOKEN	Authorization-otsikko puuttuu
AUTH_INVALID_TOKEN	Tokenia ei voitu vahvistaa
AUTH_EXPIRED_TOKEN	Token on vanhentunut
TENANT_NOT_FOUND	Vuokralaista ei ole olemassa
TENANT_NOT_CONNECTED	Microsoft-suostumusta ei ole suoritettu
SCAN_NOT_FOUND	Skannaus-ID:tä ei ole olemassa
SCAN_ALREADY_RUNNING	Skannaus on jo käynnissä tälle vuokralaiselle
SCAN_PLAN_LIMIT_REACHED	Skannauskiintiö on käytetty nykyiselle suunnitelmalle
VALIDATION_ERROR	Pyynnön runko tai kyselyparametrit ovat virheellisiä
INTERNAL_ERROR	Odottamaton palvelinvirhe

Nopeusrajoitukset

API:n nopeusrajoitus on 120 pyyntöä minuutissa. Rajan ylittäminen palauttaa 429 Too Many Requests. Retry-After-otsikko ilmoittaa kuinka monta sekuntia odottaa ennen uutta yritystä.