List all Alerts for an Incident

curl --request GET \
  --url https://api.alerty.ai/incident/{id}/alert \
  --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": "TRIGGED",
    "severity": "NOT_DEFINED",
    "description": "<string>",
    "query": "<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>"
        }
      }
    },
    "resolvedAt": "2023-11-07T05:31:56Z",
    "resolvedBy": {
      "id": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "emailVerified": true,
      "profilePictureURL": "<string>"
    }
  }
]

GET

incident

{id}

alert

List all Alerts for an Incident

curl --request GET \
  --url https://api.alerty.ai/incident/{id}/alert \
  --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": "TRIGGED",
    "severity": "NOT_DEFINED",
    "description": "<string>",
    "query": "<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>"
        }
      }
    },
    "resolvedAt": "2023-11-07T05:31:56Z",
    "resolvedBy": {
      "id": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "emailVerified": true,
      "profilePictureURL": "<string>"
    }
  }
]

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

the incident identifier Unique identifier for the entity

Example:

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

Response

successful retrieved incident alerts

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 alert title

state

enum<string>

required

state of the alert during its lifecycle

Available options:

TRIGGED,

RESOLVED

severity

enum<string>

required

alert severity

Available options:

NOT_DEFINED,

CRITICAL,

HIGH,

MEDIUM,

LOW

description

string

the alert description field

query

string

the monitor query

monitor

object

the common monitor interval configuration resource monitor

Show child attributes

monitor.id

string<uuid>

required

Unique identifier for the entity

Example:

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

monitor.createdAt

string<date-time>

required

monitor.updatedAt

string<date-time>

required

monitor.name

string

required

the monitor name

monitor.type

enum<string>

required

the monitor type

Available options:

UP_TIME,

LATENCY,

LOAD_TIME,

WEBSITE_TYPO,

STRIPE,

DOMAIN_EXPIRATION,

CERT_EXPIRATION,

CDN_CONFIGURATION,

CLOUDFLARE_REQUESTS,

CLOUDFRONT_REQUESTS,

STATUS_PAGE,

DATABASE_STORAGE_LIMIT,

DATABASE_CPU_USAGE,

DATABASE_MEMORY_USAGE

monitor.resourceId

string<uuid>

required

monitor.state

enum<string>

required

state of the monitor during its lifecycle

Available options:

ACTIVE,

PAUSED,

SNOOZED,

ERROR

monitor.status

enum<string>

required

status of the monitor

Available options:

NO_DATA,

OK,

ALERT,

WARN

monitor.priority

enum<string>

required

monitor priority

Available options:

NOT_DEFINED,

CRITICAL,

HIGH,

MEDIUM,

LOW,

INFO

monitor.recipients

object[]

required

the monitor recipients of the incidents/alerts notifications

Show child attributes

monitor.recipients.id

string<uuid>

required

Unique identifier for the entity

Example:

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

monitor.recipients.createdAt

string<date-time>

required

monitor.recipients.updatedAt

string<date-time>

required

monitor.recipients.integration

object

required

the integration information

Show child attributes

monitor.recipients.integration.id

string<uuid>

required

Unique identifier for the entity

Example:

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

monitor.recipients.integration.createdAt

string<date-time>

required

monitor.recipients.integration.updatedAt

string<date-time>

required

monitor.recipients.integration.type

enum<string>

required

the integration type

Available options:

SLACK,

PAGERDUTY,

EMAIL

monitor.recipients.integration.class

enum<string>

required

the integration class

Available options:

NOTIFICATION,

CLOUD_PROVIDER

monitor.recipients.integration.configuration

object

required

the slack integration configuration

Option 1
Option 2

Show child attributes

monitor.recipients.integration.configuration.teamId

string

required

the team ID associated with the integration/app

monitor.recipients.integration.configuration.accessToken

string

required

the slack access token returned from the oauth

monitor.recipients.integration.configuration.incomingWebhookURL

string

required

the slack incoming webhook url returned from the oauth

monitor.recipients.integration.configuration.channelID

string

the default slack channel

monitor.recipients.integrationOverride

object

the slack integration configuration

Option 1
Option 2

Show child attributes

monitor.recipients.integrationOverride.teamId

string

required

the team ID associated with the integration/app

monitor.recipients.integrationOverride.accessToken

string

required

the slack access token returned from the oauth

monitor.recipients.integrationOverride.incomingWebhookURL

string

required

the slack incoming webhook url returned from the oauth

monitor.recipients.integrationOverride.channelID

string

the default slack channel

monitor.pollDurationInterval

string<duration>

the interval in which the monitor will be checked

Example:

"P3Y6M4DT12H30M5S"

monitor.description

string

the monitor description

monitor.snoozedUntil

string<date-time>

until when the monitor will be in snoozed mode

monitor.query

string

the monitor query

monitor.resource

object

Show child attributes

monitor.resource.id

string<uuid>

required

Unique identifier for the entity

Example:

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

monitor.resource.createdAt

string<date-time>

required

monitor.resource.updatedAt

string<date-time>

required

monitor.resource.name

string

required

the inventory resource name

monitor.resource.type

enum<string>

required

the inventory resource type

Available options:

WEBSITE,

DATABASE,

COMPUTE,

STRIPE,

AWS_CLOUDFRONT,

CLOUDFLARE,

STATUS_PAGE,

RDS_DATABASE

monitor.resource.configuration

object

required

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8

Show child attributes

monitor.resource.configuration.url

string

required

the website resource URL

resolvedAt

string<date-time>

timestamp when incident was closed

resolvedBy

object

Show child attributes

resolvedBy.id

string

required

the user workos ID

resolvedBy.email

string

required

the user email address

resolvedBy.firstName

string

required

the user first name

resolvedBy.lastName

string

required

the user last name

resolvedBy.emailVerified

boolean

required

flags if the user email was already verified

resolvedBy.profilePictureURL

string

required

the user profile picture URL

List all Logs for an Incident List all Notes for Incident

⌘I

API Documentation

API Reference

List all Alerts for an Incident

Authorizations

Path Parameters

Response