Give Feedback

pydo.uptime.create_check()

Generated on 8 May 2026 from pydo version v0.34.0

Copy page as Markdown View page as Markdown

Usage

client.uptime.create_check(
    body={
        "name": "Landing page check",
        "type": "https",
        "target": "https://www.landingpage.com",
        ...,
    },
)

Returns JSONRaises HttpResponseError

Description

To create an Uptime check, send a POST request to /v2/uptime/checks specifying the attributes in the table below in the JSON body.

Parameters

name string required

Example: Landing page check

A human-friendly display name.

type string required

The type of health check to perform.

One of: ping, http, https

target string required

Example: https://www.landingpage.com

The endpoint to perform healthchecks on.

regions array of strings required

Example: ['us_east', 'eu_west']

An array containing the selected regions to perform healthchecks from.

enabled boolean required

Example: True

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

Default: True

Request Sample

Show 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_create(body=req)

Response Example

Show 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 in the API reference for additional detail on responses, headers, parameters, and more.