doctl monitoring uptime alert create
Generated on 9 Apr 2025
from doctl version
v1.124.0
Usage
doctl monitoring uptime alert create <uptime-check-id> [flags]Aliases
cDescription
Creates an alert policy for an uptime check.
You can create an alert policy based on the following metrics:
- `latency`: Alerts on the response latency. `--threshold` value is an integer representing milliseconds.
- `down`: Alerts on whether the endpoints registers as down from any of the configured regions. No `--threshold` value is necessary.
- `down_global`: Alerts on a target registering as down globally. No `--threshold` value is necessary.
- `ssl_expiry`: Alerts on an SSL certificate expiring within the set threshold of days. `--threshold` value is an integer representing days.
Example
The following example creates an alert for an uptime check with an ID of f81d4fae-7dec-11d0-a765-00a0c91e6bf6. The alert triggers if the endpoint’s latency exceed 500ms for more than two minutes:
doctl monitoring uptime alert create f81d4fae-7dec-11d0-a765-00a0c91e6bf6 --name "Example Alert" --type latency --threshold 100 --comparison greater_than --period 2m --emails "[email protected]"Flags
| Option | Description |
|---|---|
--comparison |
A comparison operator used against the alert’s threshold. Possible values: greater_than or less_than |
--emails |
Emails addresses to send alerts. The addresses must be associated with your DigitalOcean account |
--format |
Columns for output in a comma-separated list. Possible values: ID, Name, Type, Threshold, Comparison, Period, Emails, Slack Channels. |
--help, -h |
Help for this command |
--name |
The name of the alert (required) |
--no-header |
Return raw data with no headers Default: false |
--period |
The period of time the threshold must be exceeded to trigger an alert. Possible values: 2m, 3m, 5m, 10m, 15m, 30m, 1h (required) |
--slack-channels |
Slack channels to send alerts to, for example, production-alerts. Must be used with the --slack-urls flag. |
--slack-urls |
A Slack webhook URL to send alerts to, for example, https://hooks.slack.com/services/T1234567/AAAAAAAA/ZZZZZZ. |
--threshold |
The threshold at which to trigger the alert. The specific threshold is dependent on the alert type. Default: 0 |
--type |
The metric to alert on. Possible values: latency, down, down_global, ssl_expiry (required) |
Related Commands
| Command | Description |
|---|---|
| doctl monitoring uptime alert | Display commands to manage uptime alerts |
Global Flags
| Option | Description |
|---|---|
--access-token, -t |
API V2 access token |
--api-url, -u |
Override default API endpoint |
--config, -c |
Specify a custom config file Default: |
--context |
Specify a custom authentication context name |
--http-retry-max |
Set maximum number of retries for requests that fail with a 429 or 500-level error
Default: 5 |
--http-retry-wait-max |
Set the minimum number of seconds to wait before retrying a failed request
Default: 30 |
--http-retry-wait-min |
Set the maximum number of seconds to wait before retrying a failed request
Default: 1 |
--interactive |
Enable interactive behavior. Defaults to true if the terminal supports it (default false)
Default: false |
--output, -o |
Desired output format [text|json] Default: text |
--trace |
Show a log of network activity while performing a command Default: false |
--verbose, -v |
Enable verbose output Default: false |