Components API

Endpoints for managing components.

List Components

GET /api/v1/components

Query Parameters

Response

{
  "data": [
    {
      "id": 1,
      "name": "API",
      "description": "REST API Service",
      "status": "operational",
      "order": 1,
      "statusPageId": 1,
      "groupId": null
    }
  ]
}

Get Component

GET /api/v1/components/:id

Create Component

POST /api/v1/components

Request Body

{
  "name": "New Service",
  "description": "Description of the service",
  "statusPageId": 1,
  "status": "operational",
  "groupId": null
}

Update Component

PATCH /api/v1/components/:id

Request Body

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

Update Status Only

PATCH /api/v1/components/:id/status

Request Body

{
  "status": "degraded"
}

Valid Statuses

• operational
• degraded
• partial_outage
• major_outage
• maintenance

Delete Component

DELETE /api/v1/components/:id

Component Groups

List Groups

GET /api/v1/component-groups

Create Group

POST /api/v1/component-groups

{
  "name": "Infrastructure",
  "statusPageId": 1
}