Incident Entry API
After you create an incident with an initial entry, you can add/update/delete entries of an existing incident.
List Incident Entries
GET
https://api.statusentry.com/v1/incidents/:incidentID/entries
This endpoint allows you to get entries for the specified incident.
Path Parameters
Name | Type | Description |
---|---|---|
incidentID | string | ID of the incident |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Authorization Token |
Get Incident Entry
GET
https://api.statusentry.com/v1/incidents/:incidentID/entries/:entryID
This endpoint allows you to get specific incident entry.
Path Parameters
Name | Type | Description |
---|---|---|
entryID | string | ID of the incident entry |
incidentID | string | ID of the incident |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Authorization Token |
Add Incident Entry
POST
https://api.statusentry.com/v1/incidents/:incidentID/entries
This endpoint allows you to add new incident entry.
Path Parameters
Name | Type | Description |
---|---|---|
incidentID | string | ID of the incident |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Authorization Token |
Request Body
Name | Type | Description |
---|---|---|
sendNotification | boolean | Set if subscribers should be notified for this update. Default is true. |
affectedComponents | object | Affected components. Fields: componentId, componentStatus (operational, degraded_performance, partial_outage, major_outage, under_maintenance) |
incidentStatus | string | Status of the incident Available values: investigating, identified, monitoring, resolved |
date | integer | Epoch time in milliseconds for this update |
message | string | Incident update message |
Update Incident Entry
PUT
https://api.statusentry.com/v1/incidents/:incidentID/entries/:entryID
This endpoint allows you to update a specific incident entry.
Path Parameters
Name | Type | Description |
---|---|---|
entryID | string | ID of the incident entry |
incidentID | string | ID of the incident |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Authorization Token |
Request Body
Name | Type | Description |
---|---|---|
sendNotification | boolean | Set if the subscribers should be notified for this update. Default is true. |
affectedComponents | object | Affected components. Fields: componentId, componentStatus (operational, degraded_performance, partial_outage, major_outage, under_maintenance) |
incidentStatus | string | Status of the incident. Available values: investigating, identified, monitoring, resolved |
date | integer | Epoch time in milliseconds for this update |
message | string | Incident update message |
Delete Incident Entry
DELETE
https://api.statusentry.com/v1/incidents/:incidentID/entries/:entryID
This endpoint allows you to delete specific incident entry.
Path Parameters
Name | Type | Description |
---|---|---|
entryID | string | ID of the incident entry |
incidentID | string | ID of the incident |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Authorization Token |
Last updated