For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.uptime.update_check(
    check_id="4de7ac8b-495b-4884-9a69-1050c6793cd6",
    body={
        "name": "Landing page check",
        "type": "https",
        "target": "https://www.landingpage.com",
        ...,
    },
)

Description

To update the settings of an Uptime check, send a PUT request to /v2/uptime/checks/{check_id}.

Parameters

check_id string required

A unique identifier for a check.

name string optional

Example: Landing page check

A human-friendly display name.

type string optional

The type of health check to perform.

One of: ping, http, https

target string optional

Example: https://www.landingpage.com

The endpoint to perform healthchecks on.

regions array of strings optional

Example: ['us_east', 'eu_west']

An array containing the selected regions to perform healthchecks from.

enabled boolean optional

Example: True

A boolean value indicating whether the check is enabled/disabled.

Default: True

Request Sample

import os
from pydo import Client

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

req = {
  "name": "Landing page check",
  "type": "https",
  "target": "https://www.landingpage.com",
  "regions": [
    "us_east",
    "eu_west"
  ],
  "enabled": True
}

resp = client.uptime.check_update(check_id="fd9fda", body=req)

Response Example

{
  "check": {
    "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4",
    "name": "Landing page check",
    "type": "https",
    "target": "https://www.landingpage.com",
    "regions": [
      "us_east",
      "eu_west"
    ],
    "enabled": true
  }
}

More Information

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