checks
Overview
Name | checks |
Type | Resource |
Id | digitalocean.uptime.checks |
Fields
Name | Datatype | Description |
---|---|---|
id | string | A unique ID that can be used to identify and reference the check. |
name | string | A human-friendly display name. |
type | string | The type of health check to perform. |
enabled | boolean | A boolean value indicating whether the check is enabled/disabled. |
regions | array | An array containing the selected regions to perform healthchecks from. |
target | string | The endpoint to perform healthchecks on. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
check_get | SELECT | check_id | To show information about an existing check, send a GET request to /v2/uptime/checks/$CHECK_ID . |
list | SELECT | To list all of the Uptime checks on your account, send a GET request to /v2/uptime/checks . | |
check_create | INSERT | data__enabled, data__name, data__regions, data__target, data__type | To create an Uptime check, send a POST request to /v2/uptime/checks specifying the attributesin the table below in the JSON body. |
check_delete | DELETE | check_id | To delete an Uptime check, send a DELETE request to /v2/uptime/checks/$CHECK_ID . A 204 statuscode with no body will be returned in response to a successful request. Deleting a check will also delete alerts associated with the check. |
_check_get | EXEC | check_id | To show information about an existing check, send a GET request to /v2/uptime/checks/$CHECK_ID . |
_list | EXEC | To list all of the Uptime checks on your account, send a GET request to /v2/uptime/checks . | |
check_update | EXEC | check_id | To update the settings of an Uptime check, send a PUT request to /v2/uptime/checks/$CHECK_ID . |