incidents

Get an incident by id

Changed on
get/incidents/{incidentId}

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/incidents/{incidentId}
  • Auth
    HTTP bearer

Path parameters

incidentIdstring required

Response

OK

successtrue required
msgstring required

Example response

{
  "data": {
    "incident": {
      "id": "65f1c2a4d8b9e0123456789c",
      "monitorId": "65f1c2a4d8b9e0123456789a",
      "teamId": "65f1c2a4d8b9e01234567890",
      "startTime": "2026-04-15T03:21:00.000Z",
      "endTime": "2026-04-15T03:34:00.000Z",
      "status": true,
      "message": "HTTP 503 from origin",
      "statusCode": 503,
      "resolutionType": "automatic",
      "createdAt": "2026-04-15T03:21:00.000Z",
      "updatedAt": "2026-04-15T03:34:00.000Z"
    },
    "monitor": {
      "id": "65f1c2a4d8b9e0123456789a",
      "name": "Marketing site",
      "description": "Production marketing site monitored from the EU region",
      "type": "http",
      "method": "GET",
      "url": "https://www.example.com",
      "port": 443,
      "isActive": true,
      "interval": 60000,
      "status": "up",
      "statusWindow": [
        true,
        true,
        true,
        true,
        true
      ],
      "statusWindowSize": 5,
      "statusWindowThreshold": 3,
      "ignoreTlsErrors": false,
      "proxyMode": "inherit",
      "useAdvancedMatching": false,
      "notifications": [
        "65f1c2a4d8b9e0123456789b"
      ],
      "tags": [],
      "customUpCodes": [],
      "cpuAlertThreshold": 90,
      "cpuAlertCounter": 0,
      "memoryAlertThreshold": 90,
      "memoryAlertCounter": 0,
      "diskAlertThreshold": 90,
      "diskAlertCounter": 0,
      "tempAlertThreshold": 80,
      "tempAlertCounter": 0,
      "selectedDisks": [],
      "group": null,
      "geoCheckEnabled": false,
      "geoCheckLocations": [],
      "geoCheckInterval": 300000,
      "recentChecks": [],
      "teamId": "65f1c2a4d8b9e01234567890",
      "userId": "65f1c2a4d8b9e01234567891",
      "createdAt": "2026-04-01T10:00:00.000Z",
      "updatedAt": "2026-04-15T14:30:00.000Z",
      "lastEvaluatedAt": 1776254400000
    },
    "user": {
      "id": "65f1c2a4d8b9e0123456789a",
      "firstName": "Ada",
      "lastName": "Lovelace",
      "email": "ada@example.com",
      "isActive": true,
      "isVerified": true,
      "role": [
        "admin"
      ],
      "teamId": "65f1c2a4d8b9e01234567890",
      "createdAt": "2026-04-01T10:00:00.000Z",
      "updatedAt": "2026-04-15T14:30:00.000Z"
    }
  }
}

Changes

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • warning

      removed the optional property // from the response with the status