Alert rules

List alert rules

get/v1/alert-rules

Request

  • Base URL: https://api.upcheck.so
  • URL: https://api.upcheck.so/v1/alert-rules
  • Auth: HTTP bearer

Response

The rules, newest first.

idstring required

Opaque identifier.

organizationIdstring required

Opaque identifier.

namestring required
enabledboolean required
subject'http' | 'certificate' | 'dns' | 'registration' | 'keyword' | 'content' | 'port' nullable required

Which check a monitor, rule or history row is about.

triggerType'days' | 'weeks' | 'on_expiration' | 'http_down' | 'http_slow' | 'port_down' | 'dns_changed' | 'keyword_failed' | 'content_changed' | 'content_failed' | 'recovered' required
triggerValuenumber required
domainIdsstring[] nullable required
frequency'once' | 'daily' | 'every_12h' | 'every_6h' | 'hourly' required

How often a rule may re-deliver the same alert while the condition holds.

channelsstring[] required
integrationIdsstring[] nullable required
emailListIdsstring[] nullable required
emailRecipientsstring[] nullable required
createdByEmailstring nullable required
createdAtnumber required

Example response

[
  {
    "id": "9b1d...",
    "organizationId": "9b1d...",
    "domainIds": [
      "9b1d..."
    ],
    "integrationIds": [
      "9b1d..."
    ],
    "emailListIds": [
      "9b1d..."
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.