Skip to main content

check_alerts

Overview

Namecheck_alerts
TypeResource
Iddigitalocean.uptime.check_alerts

Fields

NameDatatypeDescription
idstringA unique ID that can be used to identify and reference the alert.
namestringA human-friendly display name.
notificationsobjectThe notification settings for a trigger alert.
periodstringPeriod of time the threshold must be exceeded to trigger the alert.
thresholdintegerThe threshold at which the alert will enter a trigger state. The specific threshold is dependent on the alert type.
typestringThe type of alert.
comparisonstringThe comparison operator used against the alert's threshold.

Methods

NameAccessible byRequired ParamsDescription
alert_getSELECTalert_id, check_idTo show information about an existing alert, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID.
listSELECTcheck_idTo list all of the alerts for an Uptime check, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts.
alert_createINSERTcheck_id, data__name, data__notifications, data__typeTo create an Uptime alert, send a POST request to /v2/uptime/checks/$CHECK_ID/alerts specifying the attributes
in the table below in the JSON body.
alert_deleteDELETEalert_id, check_idTo delete an Uptime alert, send a DELETE request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID. A 204 status
code with no body will be returned in response to a successful request.
_alert_getEXECalert_id, check_idTo show information about an existing alert, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID.
_listEXECcheck_idTo list all of the alerts for an Uptime check, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts.
alert_updateEXECalert_id, check_idTo update the settings of an Uptime alert, send a PUT request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID.