API-referens

Underhålls av: Aether365 Team Målgrupp: Utvecklare och DevOps-ingenjörer Omfattning: Aether365 REST API - översikt, bas-URL och svarsformat

Aether365 API låter dig programmatiskt komma åt skanningsdata, starta skanningar, hantera tenants och styra AI Pilot - generera, granska och tillämpa automatisk remediering, läsa identitetsrisksignaler och härda policyer.

Endpointgrupper

Område	Vad det omfattar
Scans	Starta och lista efterlevnads- och exponeringsskanningar
Results	Läsa enskilda skanningsfynd
AI Pilot	Generera, granska och tillämpa automatiska remedieringsplaner
Threat Alerts	Identitetsrisksignaler och inneslutning av användare med ett klick
Policies	Läsa policystatus och härda policyer på tillåtelselistan
Tenants	Läsa och uppdatera tenantprofil
Connections	Hantera anslutna Microsoft 365-tenants
Scheduled Scans	Automatisera återkommande skanningar

Bas-URL

https://api.aether365.io

Alla endpoints är relativa till denna bas-URL.

Autentisering

API:et använder Bearer token-autentisering. Inkludera en giltig JWT-token i Authorization-headern för varje begäran:

Authorization: Bearer <token>

Tokens utfärdas av Aether365:s autentiseringssystem. Se Autentisering för detaljer om hur du erhåller en token.

Svarsformat

Alla API-svar använder en konsekvent JSON-struktur.

Lyckat svar

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

För listendpoints:

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

För åtgärdsendpoints (trigger, delete):

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

Felsvar

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

HTTP-statuskoder

Kod	Betydelse
200	Lyckat
201	Resurs skapad
400	Ogiltig begäran - saknade eller felformaterade parametrar
401	Autentisering krävs eller ogiltig token
403	Åtkomst nekad - tenant-isoleringsöverträdelse
404	Resursen hittades inte
409	Konflikt - till exempel en skanning körs redan
429	Plangräns nådd
500	Internt serverfel

Felkoder

Kod	Beskrivning
AUTH_MISSING_TOKEN	Authorization-header saknas
AUTH_INVALID_TOKEN	Token kunde inte verifieras
AUTH_EXPIRED_TOKEN	Token har gått ut
TENANT_NOT_FOUND	Tenant finns inte
TENANT_NOT_CONNECTED	Microsoft-samtycke inte slutfört
SCAN_NOT_FOUND	Skannings-ID finns inte
SCAN_ALREADY_RUNNING	En skanning pågår redan för denna tenant
SCAN_PLAN_LIMIT_REACHED	Skanningskvoten för nuvarande plan är uttömd
VALIDATION_ERROR	Begärandekropp eller frågeparametrar är ogiltiga
INTERNAL_ERROR	Oväntat serverfel

Hastighetsbegränsningar

API:et har en hastighetsbegränsning på 120 begäranden per minut. Att överskrida gränsen returnerar 429 Too Many Requests. Retry-After-headern anger hur många sekunder du ska vänta innan du försöker igen.