Skip to main content

alert_policies

Creates, updates, deletes, gets or lists an alert_policies resource.

Overview​

Namealert_policies
TypeResource
Iddigitalocean.monitoring.alert_policies

Fields​

The following fields are returned by SELECT queries:

An alert policy.

NameDatatypeDescription
alertsobject
comparestring (example: GreaterThan)
descriptionstring (example: CPU Alert)
enabledboolean
entitiesarray
tagsarray
typestring (example: v1/insights/droplet/cpu)
uuidstring (example: 78b3da62-27e5-49ba-ac70-5db0b5935c64)
valuenumber (float)
windowstring (example: 5m)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
monitoring_get_alert_policyselectalert_uuidTo retrieve a given alert policy, send a GET request to /v2/monitoring/alerts/{alert_uuid}
monitoring_list_alert_policyselectper_page, pageReturns all alert policies that are configured for the given account. To List all alert policies, send a GET request to /v2/monitoring/alerts.
monitoring_create_alert_policyinsertdata__type, data__description, data__compare, data__value, data__window, data__entities, data__tags, data__alerts, data__enabledTo create a new alert, send a POST request to /v2/monitoring/alerts.
monitoring_update_alert_policyreplacealert_uuid, data__type, data__description, data__compare, data__value, data__window, data__entities, data__tags, data__alerts, data__enabledTo update en existing policy, send a PUT request to v2/monitoring/alerts/{alert_uuid}.
monitoring_delete_alert_policydeletealert_uuidTo delete an alert policy, send a DELETE request to /v2/monitoring/alerts/{alert_uuid}

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
alert_uuidstringA unique identifier for an alert policy. (example: 4de7ac8b-495b-4884-9a69-1050c6793cd6)
pageintegerWhich 'page' of paginated results to return. (example: 1)
per_pageintegerNumber of items returned per page (example: 2)

SELECT examples​

To retrieve a given alert policy, send a GET request to /v2/monitoring/alerts/{alert_uuid}

SELECT
alerts,
compare,
description,
enabled,
entities,
tags,
type,
uuid,
value,
window
FROM digitalocean.monitoring.alert_policies
WHERE alert_uuid = '{{ alert_uuid }}' -- required;

INSERT examples​

To create a new alert, send a POST request to /v2/monitoring/alerts.

INSERT INTO digitalocean.monitoring.alert_policies (
data__alerts,
data__compare,
data__description,
data__enabled,
data__entities,
data__tags,
data__type,
data__value,
data__window
)
SELECT 
'{{ alerts }}' --required,
'{{ compare }}' --required,
'{{ description }}' --required,
{{ enabled }} --required,
'{{ entities }}' --required,
'{{ tags }}' --required,
'{{ type }}' --required,
{{ value }} --required,
'{{ window }}' --required
RETURNING
policy
;

REPLACE examples​

To update en existing policy, send a PUT request to v2/monitoring/alerts/{alert_uuid}.

REPLACE digitalocean.monitoring.alert_policies
SET 
data__alerts = '{{ alerts }}',
data__compare = '{{ compare }}',
data__description = '{{ description }}',
data__enabled = {{ enabled }},
data__entities = '{{ entities }}',
data__tags = '{{ tags }}',
data__type = '{{ type }}',
data__value = {{ value }},
data__window = '{{ window }}'
WHERE 
alert_uuid = '{{ alert_uuid }}' --required
AND data__type = '{{ type }}' --required
AND data__description = '{{ description }}' --required
AND data__compare = '{{ compare }}' --required
AND data__value = '{{ value }}' --required
AND data__window = '{{ window }}' --required
AND data__entities = '{{ entities }}' --required
AND data__tags = '{{ tags }}' --required
AND data__alerts = '{{ alerts }}' --required
AND data__enabled = {{ enabled }} --required
RETURNING
policy;

DELETE examples​

To delete an alert policy, send a DELETE request to /v2/monitoring/alerts/{alert_uuid}

DELETE FROM digitalocean.monitoring.alert_policies
WHERE alert_uuid = '{{ alert_uuid }}' --required;