Status

Get the overall status of all your monitors with a single API call. Returns aggregate health and individual monitor states.

Last updated · Sergio Xalambrí

The Status endpoint provides a consolidated view of your team's monitoring health, including the overall status and individual monitor states.

GET /api/v1/status

Returns the overall status of all monitors in your team, along with a summary and details for each monitor.

Required scope: monitors:read

Response Fields

All fields live under data.status.

  • overallstring

    Overall team status: operational, partial_outage, major_outage, or unknown

  • monitorsarray

    Every HTTP monitor on the team, enabled or not, newest first

  • monitors[].idstring

    Unique monitor identifier

  • monitors[].namestring

    Display name of the monitor

  • monitors[].statusstring

    up, down, or unknown, from the monitor's latest completed check

  • monitors[].enabledboolean

    Whether the monitor is actively checking

  • monitors[].lastChecknumber | null

    When the latest check completed, in milliseconds since the epoch, or null if never checked

  • monitors[].responseTimeMsnumber | null

    Response time of the latest check in milliseconds, or null if unavailable

  • summaryobject

    Aggregate counts of monitor states

  • summary.totalnumber

    Number of enabled monitors, the set overall is computed from; the other counts sum to it

  • summary.upnumber

    Count of enabled monitors with up status

  • summary.downnumber

    Count of enabled monitors with down status

  • summary.degradednumber

    Always 0; monitors on this endpoint report up, down, or unknown

  • summary.unknownnumber

    Count of enabled monitors with unknown status

Monitor Status Calculation

A monitor is up when its latest completed check returned the monitor's expected status code, down when it returned any other status code, and unknown when it has no completed check with a status code (never checked, or the latest check got no response).

Overall Status Calculation

The overall field considers enabled monitors only:

  • operational - No enabled monitor is down

  • partial_outage - Some enabled monitors are down, but not all

  • major_outage - All enabled monitors are down

  • unknown - The team has no enabled monitors

Errors (2)
StatusTypeMeaning
401unauthorizedThe API key is missing or invalid
403forbiddenThe API key lacks the required scope
Response fields (200)
  • dataobjectRequired
    Show nested fields
    • statusobjectRequired
      Show nested fields
      • overallstringRequired

        unknown when the team has no enabled monitor One of operational, partial_outage, major_outage, unknown.

      • monitorsMonitorStatus[]Required
        Show nested fields
        • idstringRequired
        • namestringRequired
        • statusstringRequired

          unknown until a completed check carries a status code One of up, down, unknown.

        • enabledbooleanRequired
        • lastCheckinteger | nullRequired

          Epoch milliseconds

        • responseTimeMsinteger | nullRequired
      • summaryobjectRequired
        Show nested fields
        • totalintegerRequired
        • upintegerRequired
        • downintegerRequired
        • degradedintegerRequired
        • unknownintegerRequired
  • metaobjectRequired
    Show nested fields
    • requestIdstringRequired

      Format: uuid.

    • timestampstringRequired

      Format: date-time.

cURL

Terminal
curl https://uptime.sergiodxa.com/api/v1/status \
  -H "Authorization: Bearer uptime_your_api_key"
request.js
let response = await fetch("https://uptime.sergiodxa.com/api/v1/status", {
	headers: {
		"Authorization": "Bearer uptime_your_api_key",
	},
});
let result = await response.json();

Response

json
{
	"data": {
		"status": {
			"overall": "partial_outage",
			"monitors": [
				{
					"id": "mon_abc123",
					"name": "Production API",
					"status": "up",
					"enabled": true,
					"lastCheck": 1771065000000,
					"responseTimeMs": 142
				},
				{
					"id": "mon_def456",
					"name": "Marketing Website",
					"status": "down",
					"enabled": true,
					"lastCheck": 1771064985000,
					"responseTimeMs": 2340
				},
				{
					"id": "mon_ghi789",
					"name": "Staging Environment",
					"status": "unknown",
					"enabled": false,
					"lastCheck": null,
					"responseTimeMs": null
				}
			],
			"summary": {
				"total": 2,
				"up": 1,
				"down": 1,
				"degraded": 0,
				"unknown": 0
			}
		}
	},
	"meta": {
		"requestId": "6b1f9d5e-4a2c-4f7e-9a10-2c8d5f3b7e41",
		"timestamp": "2026-02-14T10:30:00.000Z"
	}
}
Documentation