pydo.uptime.update_check()

Generated on 25 November 2024 from pydo version v0.6.0

Description

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

Parameters

Name Type Required Description Default Value
check_id string True A unique identifier for a check.
body JSON or IO[bytes] 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)

Responses

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

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.

Click to expand an 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
  }
}

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"
}
Control Panel Blog Pricing Careers Terms Privacy Status API Docs Tutorials Support