📖 API Reference Overview
Monitron SaaS provides HTTP endpoints for integrating external services — primarily for Heartbeat monitoring and Server Agent reporting.
🔗 Base URL
All API endpoints use your Monitron installation URL:
https://your-monitron.com
🔑 Authentication
| Endpoint | Auth Method |
|---|---|
| Heartbeat API | Token in URL path (no headers needed) |
| Agent API | agent_key in request body |
No API keys, OAuth, or Bearer tokens required — authentication is built into the endpoint structure.
📋 Available Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET/POST | /heartbeat/{token} | Send a heartbeat ping |
POST | /heartbeat/{token}/fail | Report a heartbeat failure |
POST | /agent/report | Submit server agent metrics |
📊 Response Format
All endpoints return JSON:
{
"status": "ok",
"message": "Heartbeat recorded"
}
Error responses:
{
"status": "error",
"message": "Invalid agent key"
}