# 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.

Base URL: `https://api-mig.proxima.tools`

## Endpoints

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

### Retrieve the status overview

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

Returns monitors, groups, incidents, maintenance windows and announcements of the status page. (No auth)

- 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 (<status>)".

#### Path parameters

- `status_page_id` (string, required): The Proxima status page ID (a UUID, hard-coded in `src/config/statusPage.ts`).

#### Headers

- `Content-Type` (string, required): `application/json`.

#### Returns 200 OK

- `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`.

#### Example request

```bash
curl -X POST "https://status.proxima.tools/status-page-api/overview/3f6c2a1e-8b7d-4c5e-9a0f-1b2c3d4e5f60" \
  -H "Content-Type: application/json" \
  -d '{}'
```

#### Example response

```json
{
  "overallStatus": {
    "_id": "0b9c8d7e-6f5a-4b3c-2d1e-0f9a8b7c6d5e",
    "name": "Operational",
    "color": {
      "_type": "Color",
      "value": "#10b981"
    },
    "isOperationalState": true,
    "priority": 1
  },
  "statusPageResources": [
    {
      "_id": "6a1f2e3d-4c5b-4a69-8877-665544332211",
      "displayName": "Datafeed",
      "displayDescription": "Charts and live trades",
      "order": 2,
      "monitorId": {
        "_type": "ObjectID",
        "value": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f"
      },
      "statusPageGroupId": {
        "_type": "ObjectID",
        "value": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f70"
      },
      "monitor": {
        "_id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
        "currentMonitorStatusId": {
          "_type": "ObjectID",
          "value": "0b9c8d7e-6f5a-4b3c-2d1e-0f9a8b7c6d5e"
        }
      }
    }
  ],
  "activeIncidents": [],
  "scheduledMaintenanceEvents": [],
  "activeAnnouncements": []
}
```
