GET
/
monitor

Authorizations

​
Authorization
string
headerrequired

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

Query Parameters

​
resourceId
string

the resource filter

Response

200 - application/json
​
id
string
required

Unique identifier for the entity

​
createdAt
string
required
​
updatedAt
string
required
​
pollDurationInterval
string

the interval in which the monitor will be checked

​
name
string
required

the monitor name

​
description
string

the monitor description

​
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
​
resourceId
string
required
​
snoozedUntil
string

until when the monitor will be in snoozed mode

​
state
enum<string>
required

state of the monitor during its lifecycle

Available options:
ACTIVE,
PAUSED,
SNOOZED,
ERROR
​
status
enum<string>
required

status of the monitor

Available options:
NO_DATA,
OK,
ALERT,
WARN
​
priority
enum<string>
required

monitor priority

Available options:
NOT_DEFINED,
CRITICAL,
HIGH,
MEDIUM,
LOW,
INFO
​
recipients
object[]
required

the monitor recipients of the incidents/alerts notifications

​
query
string

the monitor query

​
resource
object
Delete a ResourceCreate a Monitor