Retrieve an Incident

Authorizations

Authorization

string

headerrequired

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

Path Parameters

string

required

the incident identifier

Response

200 - application/json

an incident trigged by a monitor/alert

string

required

Unique identifier for the entity

createdAt

string

required

updatedAt

string

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

monitor.id

string

required

Unique identifier for the entity

monitor.createdAt

string

required

monitor.updatedAt

string

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

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

monitor.pollDurationInterval

string

the interval in which the monitor will be checked

monitor.description

string

the monitor description

monitor.snoozedUntil

string

until when the monitor will be in snoozed mode

monitor.query

string

the monitor query

monitor.resource

object

createdBy

object

acknowledgedAt

string

timestamp when incident was acknowledged

acknowledgedBy

object

reopenedAt

string

timestamp when incident was reopened

reopenedBy

object

closedAt

string

timestamp when incident was closed

closedBy

object

resolvedAt

string

timestamp when incident was closed

resolvedBy

object

snoozedUntil

string

until when the monitor will be in snoozed mode

snoozeddBy

object

notes

object[]

list of incidents notes

API Documentation

API Reference

Retrieve an Incident

Authorizations

Path Parameters

Response