API de Scans

Mantenido por: Aether365 Team Audiencia: Desarrolladores Alcance: Endpoints de la API de Scans - lanzar y listar análisis

Listar análisis

Devuelve una lista paginada de análisis del tenant autenticado.

GET /tenants/{tenantId}/scans

Parámetros de consulta

Parámetro	Tipo	Descripción
page	integer	Número de página (por defecto: 1)
limit	integer	Resultados por página (por defecto: 20, máximo: 100)
status	string	Filtrar por estado: in_progress, completed, failed
scan_type	string	Filtrar por tipo: compliance, exposure

Solicitud de ejemplo

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

Respuesta de ejemplo

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

---

Obtener un análisis

Devuelve los detalles de un análisis concreto.

GET /scans/{scanId}

Solicitud de ejemplo

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

Respuesta de ejemplo

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

---

Lanzar un análisis

Inicia un análisis de forma inmediata para el tenant especificado.

POST /tenants/{tenantId}/scans

Cuerpo de la solicitud

{
  "scan_type": "compliance"
}

Campo	Tipo	Obligatorio	Valores
scan_type	string	Si	compliance, exposure

Solicitud de ejemplo

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

Respuesta de ejemplo

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

Errores

Código	HTTP	Descripción
SCAN_ALREADY_RUNNING	409	Ya hay un análisis de este tipo en curso para este tenant
TENANT_NOT_CONNECTED	400	El consent de Microsoft no se ha completado para este tenant
SCAN_PLAN_LIMIT_REACHED	429	Cuota de análisis agotada para el período de facturación actual