Uptimeify Docs

Appearance

Configurations ​

Manage advanced monitoring settings for your websites.

Check Configuration ​

Update Check Settings ​

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

Configure what aspects of the website should be monitored.

Request Body ​

json
{
  "checkSslEnabled": true,
  "checkHttpsRedirectEnabled": true,
  "checkStatusEnabled": true,
  "checkSizeEnabled": true,
  "checkResponseTimeEnabled": true,
  "checkKeywordEnabled": false,
  "minPageSize": 1024, // in bytes (optional)
  "maxPageSize": 5242880 // in bytes (optional)
}

Alert Configurations ​

List Alert Configs ​

GET /api/websites/:websiteId/alert-configs

Create Alert Config ​

POST /api/websites/:websiteId/alert-configs

Request Body ​

json
{
  "type": "status", // status, ssl, performance
  "threshold": 3, // Number of failures before alerting
  "channels": ["email", "slack"]
}

Update Alert Config ​

PUT /api/alert-configs/:id

Delete Alert Config ​

DELETE /api/alert-configs/:id

Maintenance Windows ​

List Maintenance Windows ​

GET /api/websites/:websiteId/maintenance-windows

Create Maintenance Window ​

POST /api/websites/:websiteId/maintenance-windows

Request Body ​

json
{
  "name": "Server Upgrade",
  "startTime": "2023-12-01T02:00:00Z",
  "endTime": "2023-12-01T04:00:00Z",
  "repeat": "none" // none, daily, weekly, monthly
}

Update Maintenance Window ​

PUT /api/maintenance-windows/:id

Delete Maintenance Window ​

DELETE /api/maintenance-windows/:id