Management API v3

Update a check by UUID

Authentication: provide a read-write project API key in the preferred X-Api-Key header. Read-only keys are not accepted for this operation. As an alternative on this POST request, api_key may be supplied in the JSON body.

post/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

Path parameters

identifierstring uuid required

The check UUID. POST and DELETE do not accept a read-only key here.

Request body

api_keystring

Management POST requests may include the project API key here instead of using the preferred X-Api-Key header.

namestring
slugstring
tagsstring
descstring
timeoutinteger
graceinteger
schedulestring
tzstring
channelsstring

Comma-separated channel UUIDs or names, * for all, or an empty string for none.

manual_resumeboolean
methods'' | 'POST'
subjectstring
subject_failstring
start_kwstring
success_kwstring
failure_kwstring
filter_subjectboolean
filter_bodyboolean
filter_http_bodyboolean
filter_default_failboolean
uniquestring[]

On create, reuse a check matching all supplied fields in this list.

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.