Skip to main content
GET
/
incident
List all Incidents
curl --request GET \
  --url https://api.alerty.ai/incident \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "title": "<string>",
    "state": "ACTIVE",
    "description": "<string>",
    "monitor": {
      "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "type": "UP_TIME",
      "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "state": "ACTIVE",
      "status": "NO_DATA",
      "priority": "NOT_DEFINED",
      "recipients": [
        {
          "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "integration": {
            "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "type": "SLACK",
            "class": "NOTIFICATION",
            "configuration": {
              "teamId": "<string>",
              "accessToken": "<string>",
              "incomingWebhookURL": "<string>",
              "channelID": "<string>"
            }
          },
          "integrationOverride": {
            "teamId": "<string>",
            "accessToken": "<string>",
            "incomingWebhookURL": "<string>",
            "channelID": "<string>"
          }
        }
      ],
      "pollDurationInterval": "P3Y6M4DT12H30M5S",
      "description": "<string>",
      "snoozedUntil": "2023-11-07T05:31:56Z",
      "query": "<string>",
      "resource": {
        "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "type": "WEBSITE",
        "configuration": {
          "url": "<string>"
        }
      }
    },
    "createdBy": {
      "id": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "emailVerified": true,
      "profilePictureURL": "<string>"
    },
    "acknowledgedAt": "2023-11-07T05:31:56Z",
    "acknowledgedBy": {
      "id": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "emailVerified": true,
      "profilePictureURL": "<string>"
    },
    "reopenedAt": "2023-11-07T05:31:56Z",
    "reopenedBy": {
      "id": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "emailVerified": true,
      "profilePictureURL": "<string>"
    },
    "closedAt": "2023-11-07T05:31:56Z",
    "closedBy": {
      "id": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "emailVerified": true,
      "profilePictureURL": "<string>"
    },
    "resolvedAt": "2023-11-07T05:31:56Z",
    "resolvedBy": {
      "id": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "emailVerified": true,
      "profilePictureURL": "<string>"
    },
    "snoozedUntil": "2023-11-07T05:31:56Z",
    "snoozeddBy": {
      "id": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "emailVerified": true,
      "profilePictureURL": "<string>"
    },
    "notes": [
      {
        "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdBy": {
          "id": "<string>",
          "email": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "emailVerified": true,
          "profilePictureURL": "<string>"
        },
        "content": "<string>"
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
resourceId
string<uuid>

the resource filter Unique identifier for the entity

Example:

"5df33a85-2b9c-40e3-8854-760ee3b8efc7"

Response

successful incidents retrieval

​
id
string<uuid>
required

Unique identifier for the entity

Example:

"5df33a85-2b9c-40e3-8854-760ee3b8efc7"

​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
title
string
required

the incident title

​
state
enum<string>
required

state of the incident during its lifecycle

Available options:
ACTIVE,
ACKNOWLEDGED,
SNOOZED,
RESOLVED,
CLOSED,
REOPENED
​
description
string

the incident description field

​
monitor
object

resource monitor

​
createdBy
object
​
acknowledgedAt
string<date-time>

timestamp when incident was acknowledged

​
acknowledgedBy
object
​
reopenedAt
string<date-time>

timestamp when incident was reopened

​
reopenedBy
object
​
closedAt
string<date-time>

timestamp when incident was closed

​
closedBy
object
​
resolvedAt
string<date-time>

timestamp when incident was closed

​
resolvedBy
object
​
snoozedUntil
string<date-time>

until when the monitor will be in snoozed mode

​
snoozeddBy
object
​
notes
object[]

list of incidents notes