API Reference

Integrate Larmeo capabilities into your own monitoring and automation systems.

API Overview

The Larmeo API provides programmatic access to platform configuration, agent status and network measurement data.

  • HTTPS-based communication
  • JSON responses
  • Token-based authentication
  • Versioned endpoints

Authentication

API requests require an access token.

Authorization: Bearer YOUR_API_TOKEN

Endpoints

GET /api/v1/status

Returns current platform status.

{
  "status": "online",
  "agents": 12,
  "version": "1.5.0"
}

GET /api/v1/agents

Returns registered agents.

{
  "agents": [
    {
      "id": "agent-001",
      "status": "online",
      "last_seen": "2026-08-07T10:00:00Z"
    }
  ]
}

GET /api/v1/metrics

Returns collected network metrics.

{
  "latency_ms": 24,
  "packet_loss": 0.01,
  "jitter_ms": 2
}

Response Codes

200 Request completed successfully
401 Authentication required
403 Access denied
404 Resource not found
500 Internal server error