Skip to content

API Scansioni

Maintainer: Aether365 Team Destinatari: Sviluppatori Ambito: Endpoint API Scansioni - avvio e consultazione delle scansioni

Elencare le scansioni

Restituisce un elenco paginato delle scansioni per il tenant autenticato.

GET /tenants/{tenantId}/scans

Parametri di query

ParametroTipoDescrizione
pageintegerNumero di pagina (predefinito: 1)
limitintegerRisultati per pagina (predefinito: 20, massimo: 100)
statusstringFiltra per stato: in_progress, completed, failed
scan_typestringFiltra per tipo: compliance, exposure

Richiesta di esempio

bash
curl https://api.aether365.io/tenants/t_abc123/scans \
  -H "Authorization: Bearer <token>"

Risposta di esempio

json
{
  "success": true,
  "data": [
    {
      "id": "scan_abc123",
      "tenant_id": "t_abc123",
      "scan_type": "compliance",
      "status": "completed",
      "started_at": "2026-04-09T00:00:00Z",
      "completed_at": "2026-04-09T00:14:23Z",
      "pass_count": 87,
      "fail_count": 12,
      "skip_count": 5,
      "score": 87.9
    }
  ],
  "meta": {
    "total": 24,
    "page": 1,
    "limit": 20
  }
}

Ottenere una scansione

Restituisce i dettagli di una singola scansione.

GET /scans/{scanId}

Richiesta di esempio

bash
curl https://api.aether365.io/scans/scan_abc123 \
  -H "Authorization: Bearer <token>"

Risposta di esempio

json
{
  "success": true,
  "data": {
    "id": "scan_abc123",
    "tenant_id": "t_abc123",
    "scan_type": "compliance",
    "status": "completed",
    "started_at": "2026-04-09T00:00:00Z",
    "completed_at": "2026-04-09T00:14:23Z",
    "pass_count": 87,
    "fail_count": 12,
    "skip_count": 5,
    "score": 87.9
  }
}

Avviare una scansione

Avvia immediatamente una scansione per il tenant specificato.

POST /tenants/{tenantId}/scans

Corpo della richiesta

json
{
  "scan_type": "compliance"
}
CampoTipoObbligatorioValori
scan_typestringcompliance, exposure

Richiesta di esempio

bash
curl -X POST https://api.aether365.io/tenants/t_abc123/scans \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"scan_type": "compliance"}'

Risposta di esempio

json
{
  "success": true,
  "data": {
    "id": "scan_xyz789",
    "tenant_id": "t_abc123",
    "scan_type": "compliance",
    "status": "in_progress",
    "started_at": "2026-04-09T10:32:00Z",
    "completed_at": null,
    "pass_count": null,
    "fail_count": null,
    "skip_count": null,
    "score": null
  }
}

Errori

CodiceHTTPDescrizione
SCAN_ALREADY_RUNNING409Una scansione di questo tipo è già in corso per questo tenant
TENANT_NOT_CONNECTED400L'admin consent Microsoft non è stato completato per il tenant
SCAN_PLAN_LIMIT_REACHED429Quota scansioni esaurita per il periodo di fatturazione corrente
Questa pagina ti è stata utile?