API de Análises

Listar Análises

Devolve uma lista paginada de análises para o tenant autenticado.

GET /tenants/{tenantId}/scans

Parâmetros de Consulta

Parâmetro	Tipo	Descrição
page	integer	Número da página (predefinido: 1)
limit	integer	Resultados por página (predefinido: 20, máximo: 100)
status	string	Filtrar por estado: in_progress, completed, failed
scan_type	string	Filtrar por tipo: compliance, exposure

Exemplo de Pedido

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

Exemplo de Resposta

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

---

Obter Análise

Devolve os detalhes de uma análise individual.

GET /scans/{scanId}

Exemplo de Pedido

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

Exemplo de Resposta

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

---

Acionar uma Análise

Inicia uma análise imediatamente para o tenant específicado.

POST /tenants/{tenantId}/scans

Corpo do Pedido

{
  "scan_type": "compliance"
}

Campo	Tipo	Obrigatório	Valores
scan_type	string	Sim	compliance, exposure

Exemplo de Pedido

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

Exemplo de Resposta

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

Erros

Código	HTTP	Descrição
SCAN_ALREADY_RUNNING	409	Uma análise deste tipo já está em execução para este tenant
TENANT_NOT_CONNECTED	400	O consentimento Microsoft não foi concluído para este tenant
SCAN_PLAN_LIMIT_REACHED	429	Quota de análises esgotada para o período de faturação atual