Websites

Create Website

POST /api/websites

post/api/websites

Request

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

Request body

namestring required
urlstring

Required except for heartbeat monitors; a hostname for dns, otherwise an http(s) URL.

allowPaidQuotaUpgradeboolean
monitoringType'combined' | 'http_status' | 'ssl_check' | 'playwright' | 'heartbeat' | 'dns'
managementType'managed' | 'self_service'
status'active' | 'inactive' | 'maintenance' | 'paused'
checkIntervalinteger
heartbeatGracePeriodMinutesinteger
heartbeatTokenstring
timeoutSecondsinteger
expectedStatusCodesstring
allowedCheckCountryCodesstring[] nullable
searchTermstring nullable
customFieldsobject nullable
authMode'none' | 'authorization_header' | 'basic'
authorizationHeaderstring nullable
basicAuthUsernamestring nullable
basicAuthPasswordstring nullable
httpMethod'GET' | 'QUERY' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS'
connectHoststring nullable
connectPortinteger nullable
connectTlsInsecureboolean
customHeadersobject nullable
requestBodystring nullable
followRedirectsboolean
cookieHandling'none' | 'jar'
mtlsEnabledboolean
mtlsClientCertstring nullable
mtlsClientKeystring nullable
playwrightScriptstring nullable
playwrightEnvobject nullable
playwrightDevicestring nullable
playwrightViewportWidthinteger nullable
playwrightViewportHeightinteger nullable
playwrightRetriesinteger nullable
playwrightTimeoutMsinteger nullable
checkExpectedResponseEnabledboolean
expectedResponseMatchType'contains' | 'equals' | 'json_path_equals' nullable
expectedResponseValuestring nullable
expectedResponseJsonPathstring nullable
checkSslEnabledboolean
checkHttpsRedirectEnabledboolean
checkStatusEnabledboolean
checkSizeEnabledboolean
checkResponseTimeEnabledboolean
checkKeywordEnabledboolean
sslNoticeDaysinteger
sslErrorDaysinteger
checkDomainExpiryEnabledboolean
domainExpiryNoticeDaysinteger
domainExpiryErrorDaysinteger
minPageSizeinteger nullable
maxPageSizeinteger nullable
dnsConfigobject

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.