Sign in
DigitalOcean-public.v2-new_Apps

List all app 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.

get/v2/apps/{app_id}/alerts

Path parameters

app_idstring required

The app ID

Response

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

Example response

{
  "alerts": [
    {
      "id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
      "component_name": "backend",
      "spec": {
        "rule": "CPU_UTILIZATION",
        "operator": "GREATER_THAN",
        "value": 2.32,
        "window": "FIVE_MINUTES"
      },
      "emails": [
        "sammy@digitalocean.com"
      ],
      "slack_webhooks": [
        {
          "url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX",
          "channel": "Channel Name"
        }
      ],
      "phase": "ACTIVE",
      "progress": {
        "steps": [
          {
            "name": "example_step",
            "status": "SUCCESS",
            "started_at": "2020-11-19T20:27:18Z",
            "ended_at": "2020-11-19T20:27:18Z",
            "reason": {
              "code": "Title of Error",
              "message": "This is an error"
            }
          }
        ]
      }
    }
  ]
}

Changes

Changed in 5 of the 8 revisions of this API.114