Sign in

v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB
DigitalOcean-public.v2-new_Uptime

Update a Check

To update the settings of an Uptime check, send a PUT request to /v2/uptime/checks/$CHECK_ID.

put/v2/uptime/checks/{check_id}

Path parameters

check_idstring uuid required

A unique identifier for a check.

Request body

namestring

A human-friendly display name.

type'ping' | 'http' | 'https'

The type of health check to perform.

targetstring url

The endpoint to perform healthchecks on.

regionsstring[]

An array containing the selected regions to perform healthchecks from.

enabledboolean

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

Example request

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

Response

The response will be a JSON object with a key called check. The value of this will be an object that contains the standard attributes associated with an uptime check.

Example response

{
  "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
  }
}