Skip to main content

Monitors

Configure automated checks to monitor your infrastructure.

Monitors Dashboard

List Monitors​

Retrieve all configured monitors.

HTTP Method & URL: GET /api/admin/UptimeTest

Request​

NameValueRequiredDescription
X-API-KEYstringYesYour unique API key.

Responses​

Description: Success. Returns all configured monitors.

[
  {
    "UptimeTestId": "3fa85f64-5717-4562-b3fc-2c963f66afc1",
    "Type": "HTTP",
    "Name": "Home Page Check",
    "Url": "https://example.com",
    "Interval": 60,
    "Availabilitypercentage": 100.0,
    "AvgResponseTime": 150.5
  }
]

Create a Monitor​

Add a new monitor.

HTTP Method & URL: POST /api/admin/UptimeTest/AddUptime

Request​

NameValueRequiredDescription
X-API-KEYstringYesYour unique API key.
Content-Typeapplication/jsonYesSending JSON data.

Responses​

Description: Success. Returns the created monitor ID.

{
  "Success": true,
  "Result": "3fa85f64-5717-4562-b3fc-2c963f66afc9",
  "Message": "Uptime test created"
}

Advanced Operations​

  • PUT /api/admin/UptimeTest: Update general test settings.
  • GET /api/admin/UptimeTest/UptimeTestSummary: Get high-level summary of all tests.
  • GET /api/admin/UptimeTest/{id}: Detailed test configuration.
  • DELETE /api/admin/UptimeTest/{id}: Remove a test.

Actions & Alerts​

  • PUT /api/admin/UptimeTest/UptimeAction: Manually trigger or pause a test action.
  • PUT /api/admin/UptimeTest/UptimeAlertAdmin: Trigger a specific admin alert.
  • GET/PUT/DELETE /api/admin/UptimeTest/ErrorRule: Manage custom error threshold rules.

Responses​

Description: Success.

Tags & Resources​

  • POST/GET /api/admin/UptimeTest/tags: Manage global uptime tags.
  • POST/GET /api/admin/UptimeTest/uptime-tags: Link tags to specific tests.
  • GET /api/admin/UptimeTest/getSlackDetail: Retrieve Slack notification details for a test.

Responses​

Description: Success.