GET /api/v1/monitors/status/:site — Single Monitor Status

This endpoint targets a single monitor by its name field and executes a real-time HTTP probe against the monitor’s registered URL. The name lookup is performed with Prisma’s mode: "insensitive" option, so the match is always case-insensitive. Once the monitor is located, checker.js fires an HTTP GET with a 5-second timeout and analyzer.js derives the operational state and trend by comparing the fresh probe against the most recent existing log entry. The outcome is written to the Log table via prisma.log.create, and the resulting saved record — the Log row — is returned directly to the caller.

Endpoint

GET /api/v1/monitors/status/:site

Authorization

string

required

A valid JWT issued by the /api/v1/auth/login endpoint.
Format: Bearer <token>

Path Parameters

site

string

required

The name value assigned to the monitor at creation time. The lookup uses a case-insensitive match, so "myservice", "MyService", and "MYSERVICE" all resolve to the same monitor. Returns 404 if no monitor with that name exists.

Request

This endpoint takes no query parameters or request body.

Example

curl -X GET https://opsmind-e07b.onrender.com/api/v1/monitors/status/MyService \
  -H "Authorization: Bearer <token>"

Response

200 — Success

Returns a JSON object with a success flag and a data object containing the persisted Log record created by this health check run.

{
  "success": true,
  "data": { ... }
}

success

boolean

Always true on a successful response.

data

object

The Log record written to the database during this health check. Fields match the Log model in schema.prisma.

Show Log record fields

integer

The auto-incrementing primary key of the newly created log entry in the Log table.

monitorId

integer

Foreign key referencing the parent Monitor record that was checked.

status

integer

The raw HTTP response code captured during the probe. Common values:

Code	Meaning
`200`	Service responded successfully
`404`	Endpoint or resource not found
`500`	Target server encountered an internal error
`0`	No response — connection timed out or refused

responseTime

integer

The time in milliseconds elapsed between sending the probe request and receiving the response (or hitting the timeout). Measured by checker.js using Date.now() before and after the Axios call.

error

string | null

The error message string if the HTTP probe threw a network-level exception (e.g., "connect ECONNREFUSED", "timeout of 5000ms exceeded"). null when the probe completed without a network-level error, even if a non-2xx HTTP status code was returned.

trend

TrendStatus enum

Describes how the service’s health has changed relative to its previous recorded state. Possible values:

Value	Description
`STABLE`	State is unchanged or healthy from the start
`DROP_DETECTED`	Service degraded or went down compared to last check
`RECOVERED`	Service came back up after a prior `DOWN` or `DEGRADED` state
`OFFLINE`	Service has been unreachable across consecutive checks

state

ServiceStatus enum

The current operational state of the monitor, derived from the live probe result. Possible values:

Value	Condition
`UP`	Online and responding within 1500 ms
`DEGRADED`	Online but response time exceeded 1500 ms
`DOWN`	Probe failed — no HTTP response received
`PENDING`	No prior log record exists for this monitor

timestamp

datetime

ISO 8601 UTC timestamp set by Prisma’s @default(now()) when the log row was inserted. Represents when the health check was recorded. Example: "2025-07-14T10:32:05.000Z".

Sample Response

{
  "success": true,
  "data": {
    "id": 204,
    "monitorId": 7,
    "status": 200,
    "responseTime": 312,
    "error": null,
    "trend": "RECOVERED",
    "state": "UP",
    "timestamp": "2025-07-14T10:32:05.000Z"
  }
}

The site name lookup is case-insensitive — "myservice", "MyService", and "MYSERVICE" all resolve to the same monitor. You don’t need to know the exact casing used when the monitor was created.

Error Responses

404 — Site Not Monitored

Returned when no monitor with the given name exists in the database.

{
  "success": false,
  "error": "Site not monitored"
}

401 — Unauthorized

Returned when the Authorization header is missing, malformed, or contains an expired or invalid JWT.

{
  "success": false,
  "error": "Unauthorized"
}

500 — Internal Server Error

Returned when an unexpected error occurs while processing the health check.

{
  "success": false,
  "error": "Error processing request"
}

Authentication

Monitors

Observability

GET /api/v1/monitors/status/:site — Single Monitor Status

Endpoint

Path Parameters

Request

Example

Response

200 — Success

Sample Response

Error Responses

404 — Site Not Monitored

401 — Unauthorized

500 — Internal Server Error

Build docs developers (and LLMs) love

Authentication

Monitors

Observability

Documentation Index

​Endpoint

​Path Parameters

​Request

​Example

​Response

​200 — Success

​Sample Response

​Error Responses

​404 — Site Not Monitored

​401 — Unauthorized

​500 — Internal Server Error

Build docs developers (and LLMs) love

Endpoint

Path Parameters

Request

Example

Response

200 — Success

Sample Response

Error Responses

404 — Site Not Monitored

401 — Unauthorized

500 — Internal Server Error