---
id: api-overview
title: API REST v1
category: api
version: 1.0
status: stable
audience:
  - user
  - administrator
  - developer
  - ai
updated_at: 2026-07-14
related:
  - user-guide-firmware-management
  - backups-overview
  - documentation-home
tags:
  - api
  - rest
  - endpoints
---

# 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.