Skip to content
API Reference

Search is only available in production builds. Try building and previewing the site to test it out locally.

Status & health

Read the public OneUptime status page and probe the API's health and latency.

Service status comes from a OneUptime status page at https://status.proxima.tools. The web client reads its public overview every 30 seconds and links incidents to https://status.proxima.tools/incidents/{id} and maintenance windows to https://status.proxima.tools/scheduled-events/{id}.

Separately, the web client polls the main API's /health route every 5 seconds to show latency and warn about a drifting system clock.

POST https://status.proxima.tools/status-page-api/overview/{status_page_id}

Served outside the main API host.

Returns monitors, groups, incidents, maintenance windows and announcements of the status page.

Token
None. This endpoint is public.
Retry
Safe to retry Read-only despite the POST method.

This is OneUptime's public status-page API, not a Proxima route. The web client sends an empty JSON object with cache: no-store and maps the result to its own model in src/lib/statusPage/parse.ts. Values are wrapped in OneUptime's typed objects ({ "_type": "DateTime", "value": ... }, { "_type": "Color", "value": ... }). Only the fields below are read; OneUptime may send more. Any non-2xx status is thrown as "Status page request failed ()".

Path parameters

  • status_page_id string Required
    The Proxima status page ID (a UUID, hard-coded in src/config/statusPage.ts).
    Example3f6c2a1e-8b7d-4c5e-9a0f-1b2c3d4e5f60

Headers

  • Content-Type string Required
    application/json.

Returns 200 OK · application/json

  • overallStatus object | null
    Overall monitor status: _id, name, color, isOperationalState, priority.
  • monitorStatuses array<object>
    All monitor status definitions (same shape as overallStatus).
  • statusPageResources array<object>
    Monitors shown on the page: _id, displayName, displayDescription, order, monitorId, monitorGroupId, statusPageGroupId, statusPageGroup, monitor.currentMonitorStatusId.
  • resourceGroups array<object>
    Groups: _id, name, description, order, isExpandedByDefault.
  • monitorStatusTimelines array<object>
    Status changes: monitorId, monitorStatus, startsAt, endsAt, createdAt.
  • monitorGroupCurrentStatuses object
    Map of monitor group ID to current monitor status ID.
  • activeIncidents array<object>
    Open incidents: _id, title, description, createdAt, declaredAt, incidentSeverity, currentIncidentState, monitors.
  • incidentPublicNotes array<object>
    Public notes: incidentId, note, postedAt.
  • scheduledMaintenanceEvents array<object>
    Maintenance windows: _id, title, description, startsAt, endsAt, createdAt, currentScheduledMaintenanceState, monitors.
  • activeAnnouncements array<object>
    Announcements: _id, title, description, createdAt, showAnnouncementAt, endAnnouncementAt.

Errors

Only the common errors: 429 when rate limited.

Web client fetchStatusPageOverview(signal) src/lib/statusPage/api.ts