API-referanse

Vedlikeholdt av: Aether365 Team Malgruppe: Utviklere og DevOps-ingeniorer Omfang: Oversikt over Aether365 REST API, basis-URL og responsformat

Aether365 API lar deg programmatisk fa tilgang til skannedata, utlose skanninger, administrere leietakere og styre AI Pilot - generere, gjennomgå og bruke automatisk utbedring, lese identitetsrisikosignaler og herde policyer.

Endepunktgrupper

Område	Hva det dekker
Scans	Utlose og liste opp samsvars- og eksponeringsskanninger
Results	Lese enkeltfunn fra skanninger
AI Pilot	Generere, gjennomgå og bruke automatiske utbedringsplaner
Threat Alerts	Identitetsrisikosignaler og inneslutning av brukere med ett klikk
Policies	Lese policytilstand og herde policyer på tillatelseslisten
Tenants	Lese og oppdatere leietakerprofil
Connections	Administrere tilkoblede Microsoft 365-leietakere
Scheduled Scans	Automatisere gjentakende skanninger

Basis-URL

https://api.aether365.io

Alle endepunkter er relative til denne basis-URLen.

Autentisering

APIet bruker Bearer-tokenautentisering. Inkluder et gyldig JWT-token i Authorization-headeren for hver foresporsels:

Authorization: Bearer <token>

Tokener utstedes av Aether365s autentiseringssystem. Se Autentisering for detaljer om hvordan du skaffer et token.

Responsformat

Alle API-responser bruker en konsekvent JSON-struktur.

Vellykket respons

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

For listeendepunkter:

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

For handlingsendepunkter (utlos, slett):

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

Feilrespons

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Lesbar beskrivelse",
    "details": {}
  }
}

HTTP-statuskoder

Kode	Betydning
200	Vellykket
201	Ressurs opprettet
400	Ugyldig forespørsel - manglende eller feilformede parametere
401	Autentisering kreves eller token er ugyldig
403	Tilgang nektet - brudd pa leietakerisolering
404	Ressurs ikke funnet
409	Konflikt - for eksempel kjorer en skanning allerede
429	Plangrense nadd
500	Intern serverfeil

Feilkoder

Kode	Beskrivelse
AUTH_MISSING_TOKEN	Authorization-header er ikke til stede
AUTH_INVALID_TOKEN	Token kunne ikke verifiseres
AUTH_EXPIRED_TOKEN	Token har utlopt
TENANT_NOT_FOUND	Leietaker eksisterer ikke
TENANT_NOT_CONNECTED	Microsoft-samtykke er ikke fullfort
SCAN_NOT_FOUND	Skannings-ID eksisterer ikke
SCAN_ALREADY_RUNNING	En skanning pagar allerede for denne leietakeren
SCAN_PLAN_LIMIT_REACHED	Skannekvoten for gjeldende plan er oppbrukt
VALIDATION_ERROR	Forespørselsbrødtekst eller spørreparametere er ugyldige
INTERNAL_ERROR	Uventet serverfeil

Hastighetsgrenser

APIet har en hastighetsgrense pa 120 foresporsler per minutt. A overskride hastighetsgrensen returnerer 429 Too Many Requests. Retry-After-headeren angir hvor mange sekunder du bor vente for du prover igjen.