Skip to main content

Monitoring API Status 🩺

To help you build robust integrations, Randmar provides a public, unauthenticated endpoint that you can use to check the real-time health and operational status of the API. This is often called a "health check" endpoint.

This is particularly useful for:

  • Automated Monitoring: Your systems can regularly ping this endpoint to ensure the API is online and responsive.
  • Troubleshooting: If you are experiencing issues with your integration, checking this endpoint can be a good first step to see if the problem is on your end or ours.

How to Check the API Status​

Simply make an HTTP GET request to the following URL:

Status URL: https://api.randmar.io/debug/system-status

You do not need any Authorization header for this request.

Example Request using cURL:

curl -X GET https://api.randmar.io/debug/system-status

Understanding the Response​

The endpoint will return a JSON object containing various performance metrics and statistics about the API server's health. This includes details about the server's thread pool, active connections, and other low-level .NET counters.

While you don't need to understand every field, the key indicator of a healthy system is a successful 200 OK HTTP response. If the API is down or experiencing major issues, this request will likely fail or time out.

The data provided can be valuable for advanced diagnostics if you are working with our support team to resolve a complex issue.

What's Next?​

Now that you know how to monitor the API's health, discover a powerful way to get structured data using natural language.