Reference > PyDo > Library Reference > uptime > get_check()

Was this page helpful?

Give Feedback

pydo.uptime.get_check()

Generated on 25 November 2024 from pydo version v0.6.0

Description

To show information about an existing check, send a GET request to /v2/uptime/checks/$CHECK_ID.

Parameters

Name	Type	Required	Description	Default Value
`check_id`	string	True	A unique identifier for a check.

Request Sample

import os
from pydo import Client

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

resp = client.uptime.check_get(check_id="fd9dfa")

Responses

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

200
401
404
429
500
default

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