> ## Documentation Index
> Fetch the complete documentation index at: https://docs.larm.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Update component

> Updates a component's name, description, position, or linked monitors

Requires `status_pages:read_write` permission.

<ParamField path="status_page_id" type="string" required>
  Status page UUID
</ParamField>

<ParamField path="id" type="string" required>
  Component UUID
</ParamField>

<ParamField body="name" type="string">
  Component name
</ParamField>

<ParamField body="description" type="string">
  Component description
</ParamField>

<ParamField body="position" type="integer">
  Display position
</ParamField>

<ParamField body="component_group_id" type="string">
  Group UUID
</ParamField>

<ParamField body="monitors" type="object[]">
  Replaces all linked monitors. Each object has `monitor_id` (monitor UUID) and `down_status`.
</ParamField>

<ResponseExample>
  ```json 200 theme={null}
  {
    "data": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "API v2",
      "description": "Updated API",
      "position": 0,
      "component_group_id": null,
      "monitors": [],
      "inserted_at": "2026-03-28T12:00:00Z",
      "updated_at": "2026-03-28T13:00:00Z"
    }
  }
  ```
</ResponseExample>