Skip to Content
Uptimeify Docs
Website configuration

Update Check Settings

Configure which aspects of the website should be monitored.

PATCH /api/websites/:websiteId/check-config

Switching checkKeywordEnabled on while the website has no searchTerm, or checkSizeEnabled while neither minPageSize nor maxPageSize is set, answers 400 checkRequiresValue: without them these checks measure nothing. searchTerm is not part of this body, so the stored one counts; for the page-size bounds the body counts, otherwise the stored value. A check that is already running is turned off when its value is missing.

Request Body

{
  "checkSslEnabled": true,
  "checkHttpsRedirectEnabled": true,
  "checkStatusEnabled": true,
  "checkSizeEnabled": true,
  "checkResponseTimeEnabled": true,
  "checkKeywordEnabled": false,
  "checkDomainExpiryEnabled": true,
  "minPageSize": 1024,
  "maxPageSize": 5242880
}

Your organization's package may forbid a given check. A true that switches such a check on answers 403 with data.code checkNotInPackage and data.check naming the field; the package is checked before the missing value. A true for a check that is already running on this website (or was never set) is accepted even when the package now forbids it, and the package never turns it off. false is always accepted.

Example (cURL)

BASE_URL="https://uptimeify.io"
TOKEN="<your-api-token>"

curl -X PATCH \
  "$BASE_URL/api/websites/101/check-config" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"checkSslEnabled":true,"checkHttpsRedirectEnabled":true,"checkStatusEnabled":true,"checkSizeEnabled":true,"checkResponseTimeEnabled":true,"checkKeywordEnabled":false,"checkDomainExpiryEnabled":true,"minPageSize":1024,"maxPageSize":5242880}'

Example Response

{
  "success": true
}

Common errors

  • 400 Invalid website ID when :websiteId is invalid
  • 401 Unauthorized when you are not logged in
  • 403 Forbidden when you do not have write access to the website
  • 403 Forbidden (checkNotInPackage) when an explicit true switches on a check the customer's package forbids (data.check names it)
  • 400 Bad Request (checkRequiresValue) when checkKeywordEnabled: true meets a website without searchTerm, or checkSizeEnabled: true has neither minPageSize nor maxPageSize (data.check, data.field)
  • 404 Website not found when the website does not exist

On this page