Skip to content

API Scans

Maintenu par : Aether365 Team Public : Développeurs Périmètre : Endpoints de l'API Scans - déclenchement et liste des analyses

Lister les analyses

Renvoie une liste paginée des analyses pour le tenant authentifié.

GET /tenants/{tenantId}/scans

Paramètres de requête

ParamètreTypeDescription
pageintegerNuméro de page (par défaut : 1)
limitintegerRésultats par page (par défaut : 20, max : 100)
statusstringFiltrer par statut : in_progress, completed, failed
scan_typestringFiltrer par type : compliance, exposure

Exemple de requête

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

Exemple de réponse

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
  }
}

Obtenir une analyse

Renvoie les détails d'une analyse individuelle.

GET /scans/{scanId}

Exemple de requête

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

Exemple de réponse

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
  }
}

Déclencher une analyse

Lance immédiatement une analyse pour le tenant spécifié.

POST /tenants/{tenantId}/scans

Corps de la requête

json
{
  "scan_type": "compliance"
}
ChampTypeRequisValeurs
scan_typestringOuicompliance, exposure

Exemple de requête

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"}'

Exemple de réponse

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
  }
}

Erreurs

CodeHTTPDescription
SCAN_ALREADY_RUNNING409Une analyse de ce type est déjà en cours pour ce tenant
TENANT_NOT_CONNECTED400Le consentement Microsoft n'a pas été complété pour ce tenant
SCAN_PLAN_LIMIT_REACHED429Le quota d'analyses est épuisé pour la période de facturation en cours
Cette page vous a-t-elle été utile ?