alerts

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

Overview

Name	alerts
Type	Resource
Id	digitalocean.apps.alerts

Fields

The following fields are returned by SELECT queries:

apps_list_alerts

A JSON object with a alerts key. This is list of object alerts.

Name	Datatype	Description
id	string	(title: The ID of the alert, example: 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf)
component_name	string	(title: Name of component the alert belongs to, example: backend)
emails	array	(title: Emails for alerts to go to)
phase	string	(UNKNOWN, PENDING, CONFIGURING, ACTIVE, ERROR) (default: UNKNOWN, example: ACTIVE)
progress	object
slack_webhooks	array	(title: Slack Webhooks to send alerts to)
spec	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
apps_list_alerts	select	app_id		List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions.

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.

Name	Datatype	Description
app_id	string	The app ID (example: 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf)

SELECT examples

apps_list_alerts

List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions.

SELECT
id,
component_name,
emails,
phase,
progress,
slack_webhooks,
spec
FROM digitalocean.apps.alerts
WHERE app_id = '{{ app_id }}' -- required
;