Management API v3

Get a check by UUID or unique key

Authentication: provide a project API key in the preferred X-Api-Key header. Read-only and read-write keys are accepted for this operation.

get/api/v3/checks/{identifier}

Request

  • Base URL: https://watchgoose.com
  • URL: https://watchgoose.com/api/v3/checks/{identifier}
  • Auth: API key in header X-Api-Key

Response

Successful response.

uuidstring uuid
unique_keystring
namestring required
slugstring required
tagsstring required
descstring required
graceinteger required

Grace period in seconds.

n_pingsinteger required
status'new' | 'up' | 'grace' | 'down' | 'paused' required
startedboolean required
last_pingstring date-time nullable required
next_pingstring date-time nullable required
manual_resumeboolean required
methods'' | 'POST' required
subjectstring required
subject_failstring required
start_kwstring required
success_kwstring required
failure_kwstring required
filter_subjectboolean required
filter_bodyboolean required
filter_http_bodyboolean required
filter_default_failboolean required
badge_urlstring uri required
last_durationinteger

Last run duration in seconds.

ping_urlstring uri
update_urlstring uri
pause_urlstring uri
resume_urlstring uri
channelsstring

Comma-separated channel UUIDs.

timeoutinteger

Period in seconds for simple checks.

schedulestring

Cron or OnCalendar expression.

tzstring

IANA time zone used by the schedule.

Changes

No recorded changes to this operation across all 1 revision of this API.