Skip to main content

RestAPI

MAPS Messaging provides multiple ways to monitor the health and performance of the server.

Available Metrics​

  • Message throughput
  • Protocol-specific metrics
  • System resource usage
  • Translation performance

Integrations​

  • Prometheus Setup — Expose JMX metrics for collection and dashboards.
  • Grafana → Build real-time dashboards from Prometheus data.
  • Other monitoring systems can integrate via the RestAPI or logs.

REST API Status​

/health​

  • Returns one of: Error, Warning, or OK.
  • If any subsystem reports an error, the response is Error.
  • If subsystems have issues but the server is still operational, the response is Warning.
  • If all checks pass, the response is OK.
  • Commonly used for Consul health checks.

/api/v1/ping​

  • Returns a simple success JSON if the server is running: 
    { "status": "Success" }

Other Endpoints​

  • All other REST API endpoints require authentication.

For detailed REST API specifications, refer to the OpenAPI documentation.