ESP Platform

Documentación oficial

Engineering · api

API REST v1

Documentación asociada a AEOS 0.7.0Revisión 1Actualizado 14/07/2026 03:36:28 CESTstable

API REST v1

La API usa JSON para metadatos y application/octet-stream para binarios.

Firmware

GET /api/v1/firmware lista fichas. GET por id devuelve detalle. POST crea firmware. Los endpoints download entregan firmware, segmentos y derivados. Las acciones de edición, clonado, bloqueo, merged y limpieza pertenecen al mismo dominio.

Backups

/api/v1/backups gestiona fichas, sesiones de captura por bloques, verify, complete, discard, ZIP y descargas. /restore valida paquetes guardados o subidos, entrega archivos de una sesión validada y registra resultado.

Documentación

GET /api/v1/documentation devuelve el catálogo legible por máquina. search acepta q. manifest incluye hashes y commit. export/markdown, export/text y export/package generan formatos completos desde Markdown. POST regenerate reconstruye el índice; debe quedar reservado a administradores cuando exista autenticación.

Errores

Los dominios de firmware y backup usan una envoltura con success, data y message. Los errores de validación deben ser comprensibles, no incluir secretos ni rutas internas y usar códigos HTTP coherentes.

Información técnica del documento
Ruta lógica
api/overview.md
Commit Git
a83cef9e1ee0c5b0b22662fe3493139d77c23570
SHA-256
0395e9ca4cb0712caf700e7046ef1545396761a2d60415736eea791432c24ca9
Regeneración
scripts/build-documentation.sh