Zum Hauptinhalt springen

๐Ÿ“– 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โ€‹

EndpointAuth Method
Heartbeat APIToken in URL path (no headers needed)
Agent APIagent_key in request body

No API keys, OAuth, or Bearer tokens required โ€” authentication is built into the endpoint structure.


๐Ÿ“‹ Available Endpointsโ€‹

MethodEndpointDescription
GET/POST/heartbeat/{token}Send a heartbeat ping
POST/heartbeat/{token}/failReport a heartbeat failure
POST/agent/reportSubmit server agent metrics

๐Ÿ“Š Response Formatโ€‹

All endpoints return JSON:

{
"status": "ok",
"message": "Heartbeat recorded"
}

Error responses:

{
"status": "error",
"message": "Invalid agent key"
}