Component Management

Components represent individual items that can have a status (e.g., API, Website).

List All Components

Retrieve a list of all components.

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

Authorization: Requires X-API-KEY

Request

Headers

Name	Value	Required	Description
X-API-KEY	string	Yes	Your unique API key.

cURL

curl -X GET "https://stg.itechops.com/api/admin/Component" \
     -H "X-API-KEY: your_api_key_here"

Responses

200 OK

Description: Success. Returns a list of components.

Response Body: ApiResponse<List<ComponentDetailModel>>

[
  {
    "ComponentId": "3fa85f64-5717-4562-b3fc-2c963f66afa0",
    "ComponentName": "Main Website",
    "ComponentDescription": "The primary customer-facing website.",
    "Status": "Operational",
    "ComponentGroupName": "Core Services",
    "IsActive": true
  }
]

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."
}

---

Update Component Status

Update the operational status of a component.

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

Request

Headers

Name	Value	Required	Description
X-API-KEY	string	Yes	Your unique API key.
Content-Type	application/json	Yes	Sending JSON data.

Payload

Body: ComponentStatusUpdateModel

{
  "ComponentId": "3fa85f64-5717-4562-b3fc-2c963f66afa0",
  "Status": "Degraded Performance",
  "Description": "High latency reported in US-East region."
}

cURL

curl -X PUT "https://stg.itechops.com/api/admin/Component" \
     -H "X-API-KEY: your_api_key_here" \
     -H "Content-Type: application/json" \
     -d '{
           "ComponentId": "3fa85f64-5717-4562-b3fc-2c963f66afa0",
           "Status": "Degraded Performance",
           "Description": "High latency reported in US-East region."
         }'

Responses

200 OK

Description: Success. Component status updated.

{
  "Success": true,
  "Message": "Component status updated successfully"
}

400 Bad Request

Description: Invalid status provided.

{
  "Success": false,
  "Result": null,
  "Message": "Invalid Status value."
}

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."
}