Skip to content

Riferimento API

Maintainer: Aether365 Team Destinatari: Sviluppatori e ingegneri DevOps Ambito: Panoramica della REST API di Aether365, URL di base e formato delle risposte

La API di Aether365 consente di accedere in modo programmatico ai dati delle scansioni, avviare scansioni, gestire i tenant e guidare AI Pilot: generare, esaminare e applicare la remediation automatica, leggere i segnali di rischio sull'identità e rafforzare le policy.

Gruppi di endpoint

AreaCosa copre
ScansAvviare ed elencare le scansioni di conformità ed esposizione
ResultsLeggere i singoli controlli di una scansione
AI PilotGenerare, esaminare e applicare piani di remediation automatici
Threat AlertsSegnali di rischio sull'identità e contenimento utente con un clic
PoliciesLeggere lo stato delle policy e rafforzare le policy della lista consentita
TenantsLeggere e aggiornare il profilo del tenant
ConnectionsGestire i tenant Microsoft 365 connessi
Scheduled ScansAutomatizzare le scansioni ricorrenti

URL di base

https://api.aether365.io

Tutti gli endpoint sono relativi a questo URL di base.

Autenticazione

L'API utilizza l'autenticazione Bearer token. Includi un token JWT valido nell'header Authorization di ogni richiesta:

Authorization: Bearer <token>

I token sono emessi dal sistema di autenticazione di Aether365. Consulta Autenticazione per i dettagli su come ottenere un token.

Formato delle risposte

Tutte le risposte API utilizzano una struttura JSON coerente.

Risposta di successo

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

Per gli endpoint di elenco:

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

Per gli endpoint di azione (trigger, delete):

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

Risposta di errore

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

Codici di stato HTTP

CodiceSignificato
200Successo
201Risorsa creata
400Richiesta non valida - parametri mancanti o errati
401Autenticazione richiesta o token non valido
403Accesso negato - violazione dell'isolamento tenant
404Risorsa non trovata
409Conflitto - ad esempio, una scansione è già in corso
429Limite del piano raggiunto
500Errore interno del server

Codici di errore

CodiceDescrizione
AUTH_MISSING_TOKENHeader Authorization non presente
AUTH_INVALID_TOKENImpossibile verificare il token
AUTH_EXPIRED_TOKENIl token è scaduto
TENANT_NOT_FOUNDIl tenant non esiste
TENANT_NOT_CONNECTEDAdmin consent Microsoft non completato
SCAN_NOT_FOUNDL'ID scansione non esiste
SCAN_ALREADY_RUNNINGUna scansione è già in corso per questo tenant
SCAN_PLAN_LIMIT_REACHEDQuota scansioni del piano attuale esaurita
VALIDATION_ERRORCorpo della richiesta o parametri di query non validi
INTERNAL_ERRORErrore imprevisto del server

Limiti di frequenza

L'API è limitata a 120 richieste al minuto. Il superamento del limite restituisce 429 Too Many Requests. L'header Retry-After indica quanti secondi attendere prima di riprovare.

Questa pagina ti è stata utile?