Skip to content

Referencia de la API

Mantenido por: Aether365 Team Audiencia: Desarrolladores e ingenieros DevOps Alcance: Visión general de la API REST de Aether365, URL base y formato de respuesta

La API de Aether365 te permite acceder programaticamente a los datos de análisis, lanzar análisis, gestionar tenants y dirigir AI Pilot: generar, revisar y aplicar remediación automatizada, leer señales de riesgo de identidad y reforzar políticas.

Grupos de endpoints

ÁreaQué cubre
ScansLanzar y listar análisis de cumplimiento y exposición
ResultsLeer hallazgos individuales de un análisis
AI PilotGenerar, revisar y aplicar planes de remediación automatizados
Threat AlertsSeñales de riesgo de identidad y contención de usuario con un clic
PoliciesLeer la postura de las políticas y reforzar las políticas de la lista de permitidos
TenantsLeer y actualizar el perfil del tenant
ConnectionsGestionar los tenants de Microsoft 365 conectados
Scheduled ScansAutomatizar análisis recurrentes

URL base

https://api.aether365.io

Todos los endpoints son relativos a esta URL base.

Autenticación

La API utiliza autenticación Bearer token. Incluye un token JWT válido en la cabecera Authorization de cada solicitud:

Authorization: Bearer <token>

Los tokens son emitidos por el sistema de autenticación de Aether365. Consulta Autenticación para más detalles sobre cómo obtener un token.

Formato de respuesta

Todas las respuestas de la API utilizan una estructura JSON consistente.

Respuesta de éxito

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

Para endpoints de lista:

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

Para endpoints de acción (trigger, delete):

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

Respuesta de error

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

Códigos de estado HTTP

CódigoSignificado
200Éxito
201Recurso creado
400Solicitud invalida - parámetros ausentes o mal formateados
401Se requiere autenticación o el token no es válido
403Acceso denegado - violación del aislamiento de tenant
404Recurso no encontrado
409Conflicto - por ejemplo, ya hay un análisis en ejecución
429Límite del plan alcanzado
500Error interno del servidor

Códigos de error

CódigoDescripción
AUTH_MISSING_TOKENCabecera Authorization no presente
AUTH_INVALID_TOKENNo se pudo verificar el token
AUTH_EXPIRED_TOKENEl token ha expirado
TENANT_NOT_FOUNDEl tenant no existe
TENANT_NOT_CONNECTEDEl consent de Microsoft no se ha completado
SCAN_NOT_FOUNDEl ID de análisis no existe
SCAN_ALREADY_RUNNINGYa hay un análisis en curso para este tenant
SCAN_PLAN_LIMIT_REACHEDLa cuota de análisis del plan actual se ha agotado
VALIDATION_ERROREl cuerpo de la solicitud o los parámetros son inválidos
INTERNAL_ERRORError inesperado del servidor

Limites de tasa

La API tiene un límite de 120 solicitudes por minuto. Si se supera el límite, se devuelve 429 Too Many Requests. La cabecera Retry-After indica cuantos segundos hay que esperar antes de reintentar.

¿Te resultó útil esta página?