Incidents
Manage real-time incidents and provide updates to your users.
Create an Incident
Create a new incident and optionally notify subscribers.
HTTP Method & URL: POST /api/admin/Incident
Authorization: Requires X-API-KEY
Request
- Headers
- Payload
- cURL
| Name | Value | Required | Description |
|---|---|---|---|
X-API-KEY | string | Yes | Your unique API key. |
Content-Type | application/json | Yes | Sending JSON data. |
Body: IncidentCreateModel
{
"Title": "Database Connectivity Issues",
"Description": "We are investigating reports of database timeouts.",
"Status": "Investigating",
"Impact": "Major Outage",
"AffectedComponents": ["3fa85f64-5717-4562-b3fc-2c963f66afa0"],
"IsNotify": true
}
curl -X POST "https://stg.itechops.com/api/admin/Incident" \
-H "X-API-KEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"Title": "Database Connectivity Issues",
"Description": "We are investigating reports of database timeouts.",
"Status": "Investigating",
"Impact": "Major Outage",
"AffectedComponents": ["3fa85f64-5717-4562-b3fc-2c963f66afa0"],
"IsNotify": true
}'
Responses
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 500 Server Error
Description: Success. Returns the created Incident ID.
Response Body: ApiResponse<Guid>
{
"Success": true,
"Result": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Message": "Incident created successfully"
}
Description: Invalid incident data.
{
"Success": false,
"Result": null,
"Message": "Title is required."
}
Description: Authentication failed.
{
"Success": false,
"Result": null,
"Message": "Invalid or missing API key."
}
Description: Internal server error.
{
"Success": false,
"Result": null,
"Message": "An unexpected error occurred."
}
Update an Incident
Add a new update or change the status of an existing incident.
HTTP Method & URL: PUT /api/admin/Incident
Request
- Payload
Body: IncidentUpdateModel
{
"IncidentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Description": "We have identified the root cause and are applying a fix.",
"Status": "Identified"
}
Responses
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 500 Server Error
Description: Success. Incident updated.
{
"Success": true,
"Message": "Incident updated successfully"
}
Description: Invalid update data.
{
"Success": false,
"Result": null,
"Message": "Incident ID not found."
}
Description: Authentication failed.
{
"Success": false,
"Result": null,
"Message": "Invalid or missing API key."
}
Description: Internal server error.
{
"Success": false,
"Result": null,
"Message": "An unexpected error occurred."
}
Resolve an Incident
Mark an incident as resolved.
HTTP Method & URL: POST /api/admin/Incident/ResolveIncident
Request
- Payload
Body: JSON object
{
"IncidentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Responses
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 500 Server Error
Description: Success. Incident resolved.
{
"Success": true,
"Message": "Incident resolved successfully"
}
Description: Invalid request.
{
"Success": false,
"Result": null,
"Message": "Incident already resolved."
}
Description: Authentication failed.
{
"Success": false,
"Result": null,
"Message": "Invalid or missing API key."
}
Description: Internal server error.
{
"Success": false,
"Result": null,
"Message": "An unexpected error occurred."
}