Download OpenAPI specification:
A REST API for monitoring website uptime and performance
Retrieve a paginated list of monitored websites
| limit | integer [ 1 .. 100 ] Default: 10 Number of websites to return (default 10) |
| offset | integer >= 0 Default: 0 Number of websites to skip (default 0) |
| search | string Search term to filter websites by URL |
| sort_by | string Enum: "id" "url" "created_at" "last_check_time" Field to sort by |
| sort_order | string Enum: "asc" "desc" Sort order |
{- "websites": [
- {
- "id": 0,
- "check_interval": 60,
- "request_timeout": 15,
- "max_redirects": 2,
- "current_status": "up",
- "avg_response_time": 0,
- "last_check_time": "2019-08-24T14:15:22Z",
- "last_up_time": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "total": 0,
- "limit": 0,
- "offset": 0
}Add a new website to monitor
| url required | string <uri> Website URL to monitor |
| check_interval | integer >= 60 Default: 60 Check interval in seconds (minimum 60) |
| request_timeout | integer Default: 15 Request timeout in seconds |
| max_redirects | integer Default: 2 Maximum number of redirects to follow |
{- "check_interval": 60,
- "request_timeout": 15,
- "max_redirects": 2
}{- "id": 0,
- "check_interval": 60,
- "request_timeout": 15,
- "max_redirects": 2,
- "current_status": "up",
- "avg_response_time": 0,
- "last_check_time": "2019-08-24T14:15:22Z",
- "last_up_time": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}Retrieve detailed information about a specific website including stats
| id required | integer Website ID |
| range | string Default: "24h" Enum: "1h" "24h" "7d" "30d" Time range for stats (default 24h) |
{- "id": 0,
- "check_interval": 60,
- "request_timeout": 15,
- "max_redirects": 2,
- "current_status": "up",
- "avg_response_time": 0,
- "last_check_time": "2019-08-24T14:15:22Z",
- "last_up_time": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "current_uptime": 0,
- "availability_percent": 0.1,
- "total_incidents": 0
}Update an existing website's configuration
| id required | integer Website ID |
| url | string <uri> Website URL to monitor |
| check_interval | integer >= 60 Check interval in seconds (minimum 60) |
| request_timeout | integer Request timeout in seconds |
| max_redirects | integer Maximum number of redirects to follow |
{- "check_interval": 60,
- "request_timeout": 0,
- "max_redirects": 0
}{- "id": 0,
- "check_interval": 60,
- "request_timeout": 15,
- "max_redirects": 2,
- "current_status": "up",
- "avg_response_time": 0,
- "last_check_time": "2019-08-24T14:15:22Z",
- "last_up_time": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}Retrieve check history for a specific website
| id required | integer Website ID |
| range | string Default: "24h" Enum: "24h" "7d" "30d" Time range for checks (default 24h) |
[- {
- "id": 0,
- "website_id": 0,
- "checked_at": "2019-08-24T14:15:22Z",
- "response_time": 0,
- "ttfb": 0,
- "dns_time": 0,
- "connect_time": 0,
- "http_status_code": 0,
- "is_up": true
}
]Retrieve aggregated check data for graphing
| id required | integer Website ID |
| range | string Default: "24h" Enum: "1h" "24h" "7d" "30d" Time range for graph data (default 24h) |
{ }Retrieve incidents for a specific website
| id required | integer Website ID |
| limit | integer [ 1 .. 50 ] Default: 10 Number of incidents to return (default 10, max 50) |
[- {
- "id": 0,
- "website_id": 0,
- "started_at": "2019-08-24T14:15:22Z",
- "ended_at": "2019-08-24T14:15:22Z",
- "duration": 0,
- "status": "active",
- "reason": "string"
}
]Retrieve statistics for a specific website
| id required | integer Website ID |
| range | string Default: "24h" Enum: "1h" "24h" "7d" "30d" Time range for stats (default 24h) |
{- "availability": 0.1,
- "avg_response_time": 0,
- "incidents": 0
}