Get an Incident
The Get Incident endpoint allows you to retrieve a specific Incident in your Garmingo Status instance.
Endpoint | Method | URL |
---|---|---|
/incidents/{id} | GET | https://garmingo.com/api/status/v1/incidents/{id} |
Query Parameters​
Parameter | Type | Description | Required | Default | Minimum | Maximum |
---|
Response​
The response is a JSON object with the following properties:
Property | Type | Description |
---|---|---|
success | boolean | Whether the request was successful. |
data | Incident | The Incident data. |
Example​
{
"success": true,
"data": {
"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"
}
}