Component Groups

Organize components into logical folders/groups.

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

Group Management

• GET /api/admin/ComponentGroup: List all groups.
• POST /api/admin/ComponentGroup: Create a group.
• PUT /api/admin/ComponentGroup: Update group settings.
• GET /api/admin/ComponentGroup/id/{id}: Retrieve group details.
• DELETE /api/admin/ComponentGroup/{id}: Delete a group.

Responses

200 OK

Description: Success.

Response Body: ApiResponse<T>

401 Unauthorized

Description: Authentication failed.

{
  "Success": false,
  "Result": null,
  "Message": "Invalid or missing API key."
}

500 Server Error

Description: Internal server error.

{
  "Success": false,
  "Result": null,
  "Message": "An unexpected error occurred."
}

---

Multi-Region Support

Manage regions and zones for distributed components.

• GET /api/admin/RegionZone/GetAll: List all defined regions and zones.
• GET /api/admin/RegionZone/GetAllComponentGroupsWithRegionAndZone: Retrieve a nested structure for region-aware components.

Responses

200 OK

Description: Success.

401 Unauthorized

Description: Authentication failed.

{
  "Success": false,
  "Result": null,
  "Message": "Invalid or missing API key."
}

500 Server Error

Description: Internal server error.

{
  "Success": false,
  "Result": null,
  "Message": "An unexpected error occurred."
}