Reference > PyDo > Library Reference > uptime > list_alerts()

Was this page helpful?

Give Feedback

pydo.uptime.list_alerts()

Generated on 25 November 2024 from pydo version v0.6.0

Description

To list all of the alerts for an Uptime check, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts.

Parameters

Name	Type	Required	Description	Default Value
`check_id`	string	True	A unique identifier for a check.
`per_page`	integer	False	Number of items returned per page	20
`page`	integer	False	Which ‘page’ of paginated results to return.	1

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

resp = client.uptime.check_alerts_list(check_id="4de7ac8b")

Responses

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.

200
401
404
429
500
default

The response will be a JSON object with a key called alerts. This will be set to an array of objects, each of which will contain the standard attributes associated with an uptime alert.

Click to expand an example response.

{
  "alerts": [
    {
      "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4",
      "name": "Landing page degraded performance",
      "type": "latency",
      "threshold": 300,
      "comparison": "greater_than",
      "notifications": {
        "email": [
          "[email protected]"
        ],
        "slack": [
          {
            "channel": "Production Alerts",
            "url": "https://hooks.slack.com/services/T1234567/AAAAAAAA/ZZZZZZ"
          },
          {
            "channel": "Production Alerts",
            "url": "https://hooks.slack.com/services/T1234567/AAAAAAAA/ZZZZZZ"
          }
        ]
      },
      "period": "2m"
    },
    {
      "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4",
      "name": "Landing page degraded performance",
      "type": "latency",
      "threshold": 300,
      "comparison": "greater_than",
      "notifications": {
        "email": [
          "[email protected]"
        ],
        "slack": [
          {
            "channel": "Production Alerts",
            "url": "https://hooks.slack.com/services/T1234567/AAAAAAAA/ZZZZZZ"
          },
          {
            "channel": "Production Alerts",
            "url": "https://hooks.slack.com/services/T1234567/AAAAAAAA/ZZZZZZ"
          }
        ]
      },
      "period": "2m"
    }
  ],
  "links": {
    "pages": {
      "pages": {
        "first": "https://api.digitalocean.com/v2/account/keys?page=1",
        "prev": "https://api.digitalocean.com/v2/account/keys?page=2"
      }
    }
  },
  "meta": {
    "total": 1
  }
}

Unauthorized

Click to expand an example response.

{
  "id": "unauthorized",
  "message": "Unable to authenticate you."
}

The resource was not found.

Click to expand an example response.

{
  "id": "not_found",
  "message": "The resource you requested could not be found."
}

API Rate limit exceeded

Click to expand an example response.

{
  "id": "too_many_requests",
  "message": "API Rate limit exceeded."
}

Server error.

Click to expand an example response.

{
  "id": "server_error",
  "message": "Unexpected server-side error"
}

Unexpected error

Click to expand an example response.

{
  "id": "example_error",
  "message": "some error message"
}