Skip to main content
Mole connecting APIs

HTTP API Reference

Complete HTTP API reference for Muti Metroo.

Base URL

http://localhost:8080

Configure via:

http:
enabled: true
address: ":8080"

Endpoint Categories

CategoryPurpose
HealthHealth checks and readiness probes
MetricsPrometheus metrics (local and remote)
AgentsRemote agent status and management
RoutesRoute management and triggers
RPCRemote command execution
File TransferFile upload/download
DashboardWeb dashboard and topology data

Authentication

Most endpoints require no authentication. RPC and file transfer endpoints require password authentication when configured.

Response Formats

  • JSON: Most endpoints return JSON
  • Plain text: Health checks return plain text
  • Binary: File downloads return binary data
  • Prometheus: Metrics endpoint returns Prometheus format

Error Responses

{
"error": "error message",
"code": "ERROR_CODE"
}

Common HTTP status codes:

  • 200 OK: Success
  • 400 Bad Request: Invalid request
  • 401 Unauthorized: Authentication failed
  • 404 Not Found: Resource not found
  • 500 Internal Server Error: Server error