Websites

Change Website Status

PATCH /api/websites/:websitePublicId

patch/api/websites/{id}

Request

  • Base URL: https://uptimeify.io
  • URL: https://uptimeify.io/api/websites/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

namestring
status'active' | 'inactive' | 'maintenance' | 'paused'

paused is stored as inactive.

managementType'managed' | 'self_service'
checkIntervalinteger
timeoutSecondsinteger

Response

OK

idinteger required
publicIdstring uuid required
customerIdinteger required
namestring required
urlstring required

heartbeat://<token> for heartbeat monitors, playwright://... for scripted ones.

monitoringType'combined' | 'http_status' | 'ssl_check' | 'playwright' | 'heartbeat' | 'dns' required
dnsConfigobject required
checkIntervalinteger required

Minutes.

timeoutSecondsinteger required
expectedStatusCodesstring nullable required
searchTermstring nullable required
playwrightDevicestring nullable required
playwrightViewportWidthinteger nullable required
playwrightViewportHeightinteger nullable required
playwrightRetriesinteger required
playwrightTimeoutMsinteger required
allowedCheckCountryCodesstring[] nullable required

ISO country codes of the allowed check locations; null = all.

customFieldsobject nullable required
authMode'none' | 'authorization_header' | 'basic' required
basicAuthUsernamestring nullable required
httpMethod'GET' | 'QUERY' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS' nullable required
followRedirectsboolean nullable required
cookieHandling'none' | 'jar' nullable required
connectHoststring nullable required
connectPortinteger nullable required
connectTlsInsecureboolean required
mtlsEnabledboolean nullable required
checkSslEnabledboolean nullable required
checkHttpsRedirectEnabledboolean nullable required
checkStatusEnabledboolean nullable required
checkSizeEnabledboolean nullable required
checkResponseTimeEnabledboolean nullable required
checkKeywordEnabledboolean nullable required
checkDomainExpiryEnabledboolean nullable required
checkExpectedResponseEnabledboolean nullable required
expectedResponseMatchType'contains' | 'equals' | 'json_path_equals' nullable required
expectedResponseValuestring nullable required
expectedResponseJsonPathstring nullable required
sslNoticeDaysinteger nullable required
sslErrorDaysinteger nullable required
domainExpiryNoticeDaysinteger nullable required
domainExpiryErrorDaysinteger nullable required
minPageSizeinteger nullable required
maxPageSizeinteger nullable required
heartbeatTokenstring nullable required

Heartbeat monitors: the token of the ping URL.

heartbeatGracePeriodMinutesinteger nullable required
status'active' | 'inactive' | 'maintenance' required
escalationDisabledboolean required
escalationDisabledReasonstring nullable required
escalationDisabledAtstring date-time nullable required
managementType'managed' | 'self_service' required
flappingSincestring date-time nullable required
notificationPhoneNumberstring nullable required
notificationEmailstring nullable required
lastCheckedAtstring date-time nullable required
lastHeartbeatAtstring date-time nullable required
createdAtstring date-time required
updatedAtstring date-time required
playwrightScriptstring nullable required

Changes

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