Skip to content

Status endpoints

8 endpoints at https://api.vaif.studio, generated from the API's OpenAPI document. The REST API page covers authentication, and All endpoints lists every group.

GET /status

Get platform status

Response 200 (application/json)
{
  ok: boolean;
  status: string;
  uptime: number;
  components: any[];
  updatedAt: string;
}

GET /status/incidents

List recent public incidents

Response 200 (application/json)
{
  incidents: {
    id: string;
    title: string;
    severity: string;
    description: string;
    status: string;
    createdAt: string (date-time);
    updatedAt: string (date-time);
  }[];
}

GET /status/uptime/{componentId}

Get uptime history for a component

ParameterInTypeRequired
componentIdpathstringYes
Response 200 (application/json)
{
  componentId: string;
  days: number;
  history: {
    date: string | string (date-time);
    uptime: number;
    avgLatency: number | null;
  }[];
}

POST /status/subscribe

Subscribe to status updates

Request body (application/json, required)
{
  email: string (email);
}
Response 200 (application/json)
{
  ok: true;
  message: string;
}

Errors: 400, with the error body.

GET /status/unsubscribe/{token}

Unsubscribe from status updates

ParameterInTypeRequired
tokenpathstring (uuid)Yes
Response 200 (application/json)
{
  ok: true;
  message: string;
}

Errors: 404, with the error body.

GET /status/subscribers/count

Get subscriber count

Response 200 (application/json)
{
  count: number;
}

GET /status/rss

RSS feed for incidents

Response 200 (application/json)
string

GET /status/atom

Atom feed for incidents

Response 200 (application/json)
string