List Incidents

The List Incidents endpoint allows you to retrieve a list of all Incidents in your Garmingo Status instance.

Endpoint	Method	URL
/incidents	GET	https://garmingo.com/api/status/v1/incidents

Query Parameters

Parameter	Type	Description	Required	Default	Minimum	Maximum
limit	number	The maximum number of Incidents to return.	No	10	1	100
page	number	The page number of the Incidents to return.	No	1	1	∞

Response

The response is a JSON object with the following properties:

Property	Type	Description
success	boolean	Whether the request was successful.
data.incidents	Incident[]	The list of Incidents.
data.count	number	The total number of Incidents.

Example

{
  "success": true,
  "data": {
    "incidents": [
      {
        "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"
      }
    ],
    "count": 1
  }
}