Skip to content

Referencia API REST

Todos los endpoints tienen el prefijo /api. Los endpoints autenticados requieren un token Bearer.

http
Authorization: Bearer <token>

Una interfaz Swagger está disponible en http://localhost:3000/docs en modo desarrollo.

Autenticación

EndpointMétodoDescripción
/api/auth/registerPOSTCrear una cuenta
/api/auth/loginPOSTAutenticarse
/api/auth/refreshPOSTRefrescar el token de acceso
/api/auth/logoutPOSTInvalidar el refresh token
/api/auth/registration-statusGETVerificar si el registro está activado

Proyectos

EndpointMétodoDescripción
/api/projectsGETListar proyectos visibles
/api/projects/publicGETListar proyectos públicos
/api/projects/mineGETListar tus proyectos
/api/projectsPOSTCrear un proyecto
/api/projects/:idPATCHActualizar un proyecto
/api/projects/:idDELETEEliminar un proyecto

Pipelines

EndpointMétodoDescripción
/api/projects/:pid/pipelinesGETListar pipelines
/api/projects/:pid/pipelinesPOSTCrear un pipeline
/api/projects/:pid/pipelines/:idGETObtener un pipeline
/api/projects/:pid/pipelines/:idPUTGuardar estado completo
/api/projects/:pid/pipelines/:id/execution-planGETPlan de ejecución (dry-run)
/api/projects/:pid/pipelines/:idDELETEEliminar un pipeline

Códigos HTTP

CódigoSignificado
200OK
201Creado
204Sin contenido
400Error de validación
401No autenticado
403Acceso denegado
404Recurso no encontrado
500Error del servidor

Released under the MIT License.