Incident Entry API

After you create an incident with an initial entry, you can add/update/delete entries of an existing incident.

get
List Incident Entries

https://api.statusentry.com/v1/incidents/:incidentID/entries
This endpoint allows you to get entries for the specified incident.
Request
Response
Request
Path Parameters
incidentID
required
string
ID of the incident
Headers
Authorization
required
string
Authorization Token
Response
200: OK
{
"customerId": "87da60eb-d7ab-4f10-9151-7df1c09c030e",
"incidentId": "8e40a4ba-5ee6-4698-8dc7-1fa0884a7487",
"entries": [
{
"sendNotification": true,
"customerId": "87da60eb-d7ab-4f10-9151-7df1c09c030e",
"id": "afc52af9-6502-42ca-8f2b-e07ca0c2b708",
"incidentId": "8e40a4ba-5ee6-4698-8dc7-1fa0884a7487",
"message": "We are investigating a problem in our signup flow. We will provide an update as soon as we have more information or within 10 minutes.",
"date": "1609681547",
"incidentStatus": "investigating",
"affectedComponents": [
{
"componentId": "fb5e3cdc-4550-47d9-a96d-287c987f2ba0",
"componentStatus": "degraded_performance"
}
]
}
]
}

get
Get Incident Entry

https://api.statusentry.com/v1/incidents/:incidentID/entries/:entryID
This endpoint allows you to get specific incident entry.
Request
Response
Request
Path Parameters
entryID
required
string
ID of the incident entry
incidentID
required
string
ID of the incident
Headers
Authorization
required
string
Authorization Token
Response
200: OK
{
"sendNotification": true,
"customerId": "87da60eb-d7ab-4f10-9151-7df1c09c030e",
"id": "afc52af9-6502-42ca-8f2b-e07ca0c2b708",
"incidentId": "8e40a4ba-5ee6-4698-8dc7-1fa0884a7487",
"message": "We are investigating a problem in our signup flow. We will provide an update as soon as we have more information or within 10 minutes.",
"date": "1609681547",
"incidentStatus": "investigating",
"affectedComponents": [
{
"componentId": "fb5e3cdc-4550-47d9-a96d-287c987f2ba0",
"componentStatus": "degraded_performance"
}
]
}

post
Add Incident Entry

https://api.statusentry.com/v1/incidents/:incidentID/entries
This endpoint allows you to add new incident entry.
Request
Response
Request
Path Parameters
incidentID
required
string
ID of the incident
Headers
Authorization
required
string
Authorization Token
Body Parameters
sendNotification
optional
boolean
Set if subscribers should be notified for this update. Default is true.
affectedComponents
optional
object
Affected components. Fields: componentId, componentStatus (operational, degraded_performance, partial_outage, major_outage, under_maintenance)
incidentStatus
required
string
Status of the incident Available values: investigating, identified, monitoring, resolved
date
required
integer
Epoch time in milliseconds for this update
message
required
string
Incident update message
Response
200: OK
{
"sendNotification": true,
"customerId": "87da60eb-d7ab-4f10-9151-7df1c09c030e",
"id": "d0eb2e3b-0617-4c4f-87a8-5be193661836",
"incidentId": "8e40a4ba-5ee6-4698-8dc7-1fa0884a7487",
"message": "We have identified the problem in signup flow. Our engineers are working on the problem to resolve.",
"date": "1609681547",
"incidentStatus": "identified",
"affectedComponents": [
{
"componentId": "fb5e3cdc-4550-47d9-a96d-287c987f2ba02",
"componentStatus": "degraded_performance"
}
]
}

put
Update Incident Entry

https://api.statusentry.com/v1/incidents/:incidentID/entries/:entryID
This endpoint allows you to update a specific incident entry.
Request
Response
Request
Path Parameters
entryID
required
string
ID of the incident entry
incidentID
required
string
ID of the incident
Headers
Authorization
required
string
Authorization Token
Body Parameters
sendNotification
optional
boolean
Set if the subscribers should be notified for this update. Default is true.
affectedComponents
optional
object
Affected components. Fields: componentId, componentStatus (operational, degraded_performance, partial_outage, major_outage, under_maintenance)
incidentStatus
required
string
Status of the incident. Available values: investigating, identified, monitoring, resolved
date
required
integer
Epoch time in milliseconds for this update
message
required
string
Incident update message
Response
200: OK
{}

delete
Delete Incident Entry

https://api.statusentry.com/v1/incidents/:incidentID/entries/:entryID
This endpoint allows you to delete specific incident entry.
Request
Response
Request
Path Parameters
entryID
required
string
ID of the incident entry
incidentID
required
string
ID of the incident
Headers
Authorization
required
string
Authorization Token
Response
200: OK
{}