API de automatización
Esta referencia se genera durante el build a partir de web/src/shared/api/openapi.json. No se mantiene una lista paralela de rutas.
| Método | Ruta | Propósito | Acceso |
|---|---|---|---|
GET |
/api/health |
Health | Público |
GET |
/api/metrics |
Prometheus | Bearer: token de métricas |
GET |
/api/cron |
Cron | Bearer: token de cron |
POST |
/api/ci/sarif |
Ci Import | Bearer: token de importación |
GET /api/health
Sección titulada «GET /api/health»Health
Autenticación: Público.
Respuestas
Sección titulada «Respuestas»| Estado | Descripción |
|---|---|
200 |
Successful Response |
GET /api/metrics
Sección titulada «GET /api/metrics»Prometheus
Autenticación: Bearer: token de métricas.
Respuestas
Sección titulada «Respuestas»| Estado | Descripción |
|---|---|
200 |
Prometheus text exposition format |
401 |
Missing or wrong bearer token |
404 |
Metrics are off (PITANGUS_METRICS_TOKEN is not set) |
GET /api/cron
Sección titulada «GET /api/cron»Cron
Autenticación: Bearer: token de cron.
Respuestas
Sección titulada «Respuestas»| Estado | Descripción |
|---|---|
200 |
Successful Response |
401 |
Missing or wrong bearer token |
404 |
Off: not PITANGUS_PERIODIC=external, or no PITANGUS_CRON_TOKEN / CRON_SECRET |
POST /api/ci/sarif
Sección titulada «POST /api/ci/sarif»The same import for a pipeline, authenticated by PITANGUS_IMPORT_TOKEN instead of a session.
Autenticación: Bearer: token de importación.
Parámetros
Sección titulada «Parámetros»| Nombre | Ubicación | Tipo | Obligatorio |
|---|---|---|---|
asset |
query | string |
No |
tool |
query | string |
No |
scope |
query | string |
No |
commit |
query | string |
No |
branch |
query | string |
No |
X-Pitangus-Actor |
header | string |
No |
Cuerpo: object.
Respuestas
Sección titulada «Respuestas»| Estado | Descripción |
|---|---|
200 |
Successful Response |
401 |
Missing or wrong bearer token |
404 |
Off (no PITANGUS_IMPORT_TOKEN), or unknown asset |
409 |
The name matches several assets |