API for Real-Time Edge Health and Telemetry Monitoring

We require a more robust methodology for monitoring the health and performance of our regional Edge appliances in real time. The standard performance dashboards provide a high-level overview, but we need to extract granular telemetry regarding CPU utilization and active trunk concurrency to inform our capacity planning. Is there a specific Platform API endpoint that provides real-time diagnostic data for on-premises Edge servers, or must we rely on external SNMP monitoring?

Hey. I manage our Edge servers and I can tell you that the API is a lot better than trying to mess with SNMP. You want to look at the /api/v2/telephony/providers/edges/{edgeId}/metrics endpoint.

It gives you a nice JSON payload with all the hardware stats you are looking for. I use a little script to pull this every five minutes and dump it into a dashboard.

It is way easier than checking the UI one by one.

That is right! We had a deep dive on this in our last user group meeting. The Edge metrics API is a goldmine for capacity planning. If you want to get really fancy, you can also hit the /api/v2/telephony/providers/edges/trunks/metrics endpoint to see exactly how your BYOC trunks are holding up.

Just be careful with the rate limits if you have a lot of Edges!

Hello. In my experience as a consultant, I recommend that you also monitor the ‘Edge Status’ event via the Notification API. This allows you to receive an immediate alert if an Edge server goes offline or loses its connection to the cloud.

By combining the polling of the metrics API with the real-time events from the notification service, you can build a very reliable monitoring framework for your global infrastructure.