Skip to main content

Component Groups

Manage groups of components to organize your status page.

X-API-KEY Required for all endpoints in this section.

List All Component Groups​

Retrieve a list of all component groups and their current status.

HTTP Method & URL: GET /api/admin/ComponentGroup

Request​

NameValueRequiredDescription
X-API-KEYstringYesYour unique API key.

Responses​

Description: Success. Returns a list of component groups.

Response Body: ApiResponse<List<ComponentGroupModel>>

{
  "Success": true,
  "Result": [
    {
      "ComponentGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa0",
      "ComponentGroupName": "Core Services",
      "ComponentGroupDescription": "Critical infrastructure components.",
      "Sequence": 1
    }
  ],
  "Message": ""
}

Get Component Group by ID​

Retrieve details for a specific component group.

HTTP Method & URL: GET /api/admin/ComponentGroup/id/{id}

Request​

  • id: (Guid) The unique ID of the component group.

Responses​

Description: Success.

Response Body: ApiResponse<ComponentGroupModel>

Create Component Group​

Add a new component group.

HTTP Method & URL: POST /api/admin/ComponentGroup

Request​

Body: ComponentGroupModel

{
  "ComponentGroupName": "Internal Tools",
  "ComponentGroupDescription": "Non-customer facing tools",
  "Sequence": 2
}

Responses​

Description: Success. Returns the ID of the created group.

Update Component Group​

Modify an existing component group.

HTTP Method & URL: PUT /api/admin/ComponentGroup

Request​

Body: ComponentGroupModel

Responses​

Description: Success.

Delete Component Group​

Remove a component group.

HTTP Method & URL: DELETE /api/admin/ComponentGroup/{id}

Request​

  • id: (Guid) The unique ID of the component group.

Responses​

Description: Success.