Give Feedback

pydo.uptime.list_alerts()

Generated on 8 May 2026 from pydo version v0.34.0

Copy page as Markdown View page as Markdown

Usage

client.uptime.list_alerts(
    check_id="4de7ac8b-495b-4884-9a69-1050c6793cd6",
    per_page=20,
    page=1,
)

Returns JSONRaises HttpResponseError

Description

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

Parameters

check_id string required

A unique identifier for a check.

per_page integer optional

Number of items returned per page

Min: 1

Max: 200

Default: 20

page integer optional

Which 'page' of paginated results to return.

Min: 1

Default: 1

Request Sample

Show 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")

Pagination

This method returns paginated results. The response includes a links.pages object with URLs for navigating between pages. To retrieve the next page, parse the next URL and pass the page parameter:

from urllib.parse import urlparse, parse_qs

resp = client.uptime.list_alerts(check_id="4de7ac8b-495b-4884-9a69-1050c6793cd6", )
pages = resp.get("links", {}).get("pages", {})

while "next" in pages:
    parsed = urlparse(pages["next"])
    page = int(parse_qs(parsed.query)["page"][0])
    resp = client.uptime.list_alerts(check_id="4de7ac8b-495b-4884-9a69-1050c6793cd6", page=page)
    pages = resp.get("links", {}).get("pages", {})

Response Example

Show Response Example

{
  "alerts": [],
  "links": {
    "pages": {
      "pages": {
        "first": "https://api.digitalocean.com/v2/account/keys?page=1",
        "prev": "https://api.digitalocean.com/v2/account/keys?page=2"
      }
    }
  }
}

More Information

See /v2/uptime/checks/{check_id}/alerts in the API reference for additional detail on responses, headers, parameters, and more.