Skip to main content
Version: Unreleased

API Introduction

This section provides an overview of the API endpoints available in the VoIP SBC Monitoring stack.

Most API endpoints are documented and accessible via the built-in Swagger UI. Swagger offers interactive documentation, allowing you to explore available endpoints, view request/response formats, and test API calls directly from your browser.

How to Access the Swagger UI​

There are two ways to open the Swagger UI:

  • From the GUI – open the user menu in the top-right corner and select API Documentation. Swagger opens in a new browser tab.
  • Directly – open /api/swagger/ on your Monitor host, for example https://monitor.example.com/api/swagger/.

The raw OpenAPI 3.0 specification is served at /api/swagger.json, which you can use to generate API clients or to import the API into other tools.

Use the Swagger UI to:

  • Browse all available API endpoints
  • View detailed documentation for each endpoint
  • Try out requests and see example responses (use Authorize to supply a JWT bearer token first)

Typical API Use Cases​

  • Query call records, alerts, and system metrics for integration with external tools
  • Automate configuration and monitoring tasks using scripts or third-party platforms
  • Integrate with dashboards, reporting, and analytics

Need More Details?​

For full API documentation, request/response schemas, and live testing, please refer to the Swagger UI provided with your deployment. If you need additional help or examples, contact support or consult the sidebar for more guides.

Ready to explore the API? Open the Swagger UI and start integrating with your VoIP SBC monitoring stack!