Status Pages API

Endpoints for managing status pages.

List Status Pages

GET /api/v1/statuspages

Response

{
  "data": [
    {
      "id": 1,
      "name": "Main Status",
      "slug": "main",
      "description": "Public status page",
      "logoUrl": null,
      "isPublic": true,
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ]
}

Get Status Page

GET /api/v1/statuspages/:id

Response

{
  "data": {
    "id": 1,
    "name": "Main Status",
    "slug": "main",
    "description": "Public status page",
    "logoUrl": null,
    "faviconUrl": null,
    "customDomain": null,
    "accentColor": "#3b82f6",
    "isPublic": true,
    "showSubscribe": true,
    "showUptime": true,
    "uptimeDays": 90,
    "timeZone": "UTC",
    "createdAt": "2024-01-15T10:30:00Z",
    "components": [...],
    "componentGroups": [...]
  }
}

Create Status Page

POST /api/v1/statuspages

Request Body

{
  "name": "New Status Page",
  "slug": "new-status",
  "description": "A new status page",
  "isPublic": true
}

Response

{
  "data": {
    "id": 2,
    "name": "New Status Page",
    "slug": "new-status",
    ...
  }
}

Update Status Page

PATCH /api/v1/statuspages/:id

Request Body

{
  "name": "Updated Name",
  "description": "Updated description"
}

Delete Status Page

DELETE /api/v1/statuspages/:id

Response

{
  "message": "Status page deleted successfully"
}

Get Public Status

GET /api/v1/public/:slug

No authentication required. Returns public status page data.