Esta página es un mapa de alto nivel del modelo de recursos expuesto por la API de plataforma. Los endpoints exactos, parámetros y esquemas están en la referencia restringida; lo que sigue es la estructura conceptual que necesitas para diseñar integraciones y razonar sobre el alcance.
El árbol de recursos
Tenant
├── Usuarios (con roles)
├── Agentes
│ └── Claves de API
├── Políticas
├── DLP
│ ├── Detectores
│ ├── Patrones (personalizados)
│ └── Listas de exenciones
├── Trazas / Sesiones
└── Log de auditoríaCada recurso distinto de Tenant está delimitado al tenant. Un JWT de la API de plataforma está delimitado al tenant, por lo que cualquier endpoint de listado que llames devolverá solo las filas de tu tenant.
Identificadores
Todos los IDs de recurso son prefijos con tipo más un ULID, p. ej.:
agent_01HX2…: un agente.pol_01HX2…: una política.key_01HX2…: una clave de API.trace_01HX2…: una única acción registrada.
Los prefijos ULID hacen que los IDs sean autodescriptivos en logs e informes de incidente.
Ciclo de vida de una acción
Leyendo el modelo de recursos de abajo arriba:
- Un agente envía una petición al proxy con su clave de API.
- El proxy resuelve el tenant a partir de la clave, evalúa políticas en orden de prioridad, ejecuta detectores DLP y reenvía (o rechaza) la petición.
- Se escribe una traza, se une a una sesión (vía
X-RenLayer-Session) y queda visible en la API tanto como traza independiente como miembro de su sesión. - Las acciones del operador sobre cualquiera de estos recursos quedan registradas en el log de auditoría.
Filtrado y paginación
Los endpoints de listado comparten una forma consistente:
limit: tamaño de página (por defecto 50, máximo 200).cursor: cursor opaco para la siguiente página.- Filtros específicos del recurso: p. ej.
agent_id,status,from,to.
Las respuestas incluyen next_cursor cuando hay más filas disponibles.
Webhooks
La plataforma puede emitir webhooks para eventos importantes (política activada con DENY, bloqueo DLP, clave revocada). La configuración de webhooks es por tenant. Los payloads se firman; la protección frente a replay usa un header X-RenLayer-Signature y un secreto específico del tenant.
Lecturas en streaming
Para grandes rangos de trazas (respuesta a incidentes, exportaciones mensuales), la API expone endpoints en streaming que devuelven NDJSON sobre una conexión de larga duración. Estos saltan la paginación por cursor y están diseñados para procesamiento por lotes.
A dónde ir después
- Autenticación
- Solicitar acceso: la referencia restringida de endpoints.
- Multi-tenancy: el modelo de aislamiento en profundidad.