Skip to main content
GET
/
monitor
/
{id}
Retrieve a Monitor
curl --request GET \
  --url https://api.alerty.ai/monitor/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "pollDurationInterval": "P3Y6M4DT12H30M5S",
  "name": "<string>",
  "description": "<string>",
  "type": "UP_TIME",
  "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "snoozedUntil": "2023-11-07T05:31:56Z",
  "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>"
      }
    }
  ],
  "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>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

the monitor identifier

Example:

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

Response

successful monitor retrieval

the common monitor interval configuration resource monitor

​
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
​
name
string
required

the monitor name

​
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<uuid>
required
​
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

​
pollDurationInterval
string<duration>

the interval in which the monitor will be checked

Example:

"P3Y6M4DT12H30M5S"

​
description
string

the monitor description

​
snoozedUntil
string<date-time>

until when the monitor will be in snoozed mode

​
query
string

the monitor query

​
resource
object