Incident Object

The Incident Object in the API represents an Incident in Garmingo Status.
This is equal to the Incident from the "Incidents" Tab in the Dashboard.

Properties

The Incident Object itself has the following properties:

Property	Type	Description	Required
id	string	The unique identifier of the Incident.	Yes
title	string	The title of the Incident.	Yes
description	string	The description of the Incident.	Yes
status	string	The status of the Incident. Only cosmetic and shown on the Status Page.	Yes
resolved	boolean	Whether the Incident is resolved.	Yes
resolveWhenOnline	boolean	Whether the Incident should be resolved when all connected Monitors are online.	Yes
monitorIds	string[]	List of Monitor IDs that are connected to the Incident.	Yes
eventIds	string[]	List of Event IDs that are connected to the Incident.	Yes
start	Date	When the Incident was started.	Yes
end	Date	When the Incident was resolved.	No
metadata	object	Additional metadata of the Incident.	No

Example

{
  "id": "5f4b3b3b-0b3b-4b3b-0b3b-4b3b0b3b0b3b",
  "title": "My Incident",
  "description": "This is a description.",
  "status": "Open",
  "resolved": false,
  "resolveWhenOnline": true,
  "monitorIds": ["5f4b3b3b-0b3b-4b3b-0b3b-4b3b0b3b0b3b"],
  "eventIds": ["5f4b3b3b-0b3b-4b3b-0b3b-4b3b0b3b0b3b"],
  "start": "2021-01-01T00:00:00.000Z"
}

CRUD Operation Objects

The base type of the Incident Object is returned by the API for all READ operations.
For CREATE, UPDATE and DELETE operations, the Incident Object is stripped down to the following properties:

Create Incident Object

Property	Type	Description	Required	Default
title	string	The title of the Incident.	Yes
description	string	The description of the Incident.	No	Empty
status	string	The status of the Incident. Only cosmetic and shown on the Status Page.	No	Open
resolveWhenOnline	boolean	Whether the Incident should be resolved when all connected Monitors are online.	No	true
monitorIds	string[]	List of Monitor IDs that are connected to the Incident.	Yes

Example

{
  "title": "My Incident",
  "monitorIds": ["5f4b3b3b-0b3b-4b3b-0b3b-4b3b0b3b0b3b"]
}

Update Incident Object

Property	Type	Description	Required
title	string	The title of the Incident.	No
description	string	The description of the Incident.	No
status	string	The status of the Incident. Only cosmetic and shown on the Status Page.	No
resolved	boolean	Whether the Incident is resolved.	No
resolveWhenOnline	boolean	Whether the Incident should be resolved when all connected Monitors are online.	No
monitorIds	string[]	List of Monitor IDs that are connected to the Incident.	No
start	Date	When the Incident was started.	No
end	Date	When the Incident was resolved.	No

Example

{
  "displayName": "My Monitor",
  "enabled": true
}