Referencia API
Documentación completa de la API para integrar con ReliaPulse.
Vista General
ReliaPulse proporciona una API RESTful para gestión programática de tu infraestructura de página de estado.
URL Base
https://tu-dominio.com/api/v1Formato de Respuesta
Todas las respuestas están en formato JSON:
{
"data": { ... },
"meta": {
"total": 100,
"page": 1,
"limit": 20
}
}Respuestas de Error
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Datos de solicitud inválidos",
"details": [...]
}
}Documentación Interactiva
Explora nuestra documentación interactiva de API impulsada por Scalar:
El explorador de API te permite:
- Navegar todos los endpoints
- Ver esquemas de request/response
- Probar llamadas API directamente
- Generar snippets de código
Endpoints
Componentes
| Método | Endpoint | Descripción |
|---|---|---|
GET | /components | Listar todos los componentes |
POST | /components | Crear componente |
GET | /components/{id} | Obtener componente |
PATCH | /components/{id} | Actualizar componente |
DELETE | /components/{id} | Eliminar componente |
POST | /components/{id}/clone | Clonar componente |
Incidentes
| Método | Endpoint | Descripción |
|---|---|---|
GET | /incidents | Listar incidentes |
POST | /incidents | Crear incidente |
GET | /incidents/{id} | Obtener incidente |
PATCH | /incidents/{id} | Actualizar incidente |
DELETE | /incidents/{id} | Eliminar incidente |
POST | /incidents/{id}/updates | Añadir actualización |
Mantenimientos
| Método | Endpoint | Descripción |
|---|---|---|
GET | /maintenances | Listar mantenimientos |
POST | /maintenances | Programar mantenimiento |
GET | /maintenances/{id} | Obtener mantenimiento |
PATCH | /maintenances/{id} | Actualizar mantenimiento |
DELETE | /maintenances/{id} | Cancelar mantenimiento |
Páginas de Estado
| Método | Endpoint | Descripción |
|---|---|---|
GET | /status-pages | Listar páginas de estado |
POST | /status-pages | Crear página de estado |
GET | /status-pages/{id} | Obtener página de estado |
PATCH | /status-pages/{id} | Actualizar página de estado |
DELETE | /status-pages/{id} | Eliminar página de estado |
Suscriptores
| Método | Endpoint | Descripción |
|---|---|---|
GET | /subscribers | Listar suscriptores |
POST | /subscribers | Añadir suscriptor |
DELETE | /subscribers/{id} | Eliminar suscriptor |
POST | /subscribers/import | Importación masiva CSV |
Integraciones
| Método | Endpoint | Descripción |
|---|---|---|
GET | /integrations | Listar integraciones |
POST | /integrations | Crear integración |
GET | /integrations/{id} | Obtener integración |
PATCH | /integrations/{id} | Actualizar integración |
DELETE | /integrations/{id} | Eliminar integración |
Consultas de Métricas
| Método | Endpoint | Descripción |
|---|---|---|
GET | /integrations/{id}/metrics | Listar consultas de métricas |
POST | /integrations/{id}/metrics | Crear consulta |
GET | /integrations/{id}/metrics/{queryId} | Obtener consulta |
PATCH | /integrations/{id}/metrics/{queryId} | Actualizar consulta |
DELETE | /integrations/{id}/metrics/{queryId} | Eliminar consulta |
On-Call
| Método | Endpoint | Descripción |
|---|---|---|
GET | /oncall/schedules | Listar horarios |
POST | /oncall/schedules | Crear horario |
GET | /oncall/alerts | Listar alertas |
POST | /oncall/alerts/{id}/acknowledge | Reconocer alerta |
Configuración
| Método | Endpoint | Descripción |
|---|---|---|
POST | /config/validate | Validar configuración YAML |
POST | /config/apply | Aplicar configuración |
GET | /config/export | Exportar configuración |
GET | /config/drift | Detectar drift |
API Pública
Endpoints públicos sin autenticación para widgets embebidos:
| Método | Endpoint | Descripción |
|---|---|---|
GET | /public/status/{slug} | Obtener estado público |
GET | /public/status/{slug}/feed | RSS/Atom/JSON feed |
SDKs y Bibliotecas
cURL
curl -X GET "https://tu-dominio.com/api/v1/components" \
-H "Authorization: Bearer sk_live_xxx" \
-H "Content-Type: application/json"JavaScript/TypeScript
const response = await fetch('https://tu-dominio.com/api/v1/components', {
headers: {
'Authorization': 'Bearer sk_live_xxx',
'Content-Type': 'application/json'
}
});
const data = await response.json();Python
import requests
response = requests.get(
'https://tu-dominio.com/api/v1/components',
headers={
'Authorization': 'Bearer sk_live_xxx',
'Content-Type': 'application/json'
}
)
data = response.json()