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

200

{
    "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 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

200

{
    "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"
        }
    ]
}

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

200

{
    "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"
        }
    ]
}

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

200

{}

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

200

{}