Prerequisites
Prerequisites
Before creating URL Monitors, ensure you have:
- An initialized Checkly CLI project
- URLs or HTTP endpoints you want to monitor
- Understanding of HTTP status codes and response behavior
- Network access to the URLs you want to monitor
Configuration
The URL Monitoring configuration consists of specific URL monitoring options and inherited general monitoring options.- URL Monitor
- General Monitor
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
request | object | ✅ | - | HTTP request configuration object |
degradedResponseTime | number | ❌ | 3000 | Response time threshold in milliseconds for degraded status |
maxResponseTime | number | ❌ | 5000 | Maximum response time in milliseconds before marking as failed |
UrlMonitor Options
HTTP request configuration that defines the URL to monitor and how to handle the request.Usage:Parameters:
Define assertions using the Examples:Use cases: Website availability, API health checks, service uptime monitoring.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
url | string | ✅ | - | The HTTP(S) URL to monitor |
followRedirects | boolean | ❌ | true | Whether to automatically follow 30x redirects |
ipFamily | IPFamily | ❌ | IPv4 | IP family version to use for the connection |
skipSSL | boolean | ❌ | false | Whether to skip validation of SSL certificates |
assertions | UrlAssertion[] | ❌ | [] | Response assertions using UrlAssertionBuilder |
UrlAssertionBuilder to validate HTTP status codes:- Simple Website
- API Endpoint
- Development Environment
Response time threshold in milliseconds for marking the monitor as degraded (warning state).Usage:Use cases: Early performance warnings, gradual degradation detection.
Maximum response time in milliseconds before the monitor is marked as failed.Usage:Examples:Use cases: Performance monitoring, SLA compliance, user experience optimization.
General Monitor Options
Friendly name for your URL monitor that will be displayed in the Checkly dashboard and used in notifications.Usage:
How often the URL monitor should run. Use the Examples:Available frequencies:
Frequency enum to set the check interval.Usage:- High Frequency
- Standard Monitoring
- Low Frequency
EVERY_10S, EVERY_20S, EVERY_30S, EVERY_1M, EVERY_2M, EVERY_5M, EVERY_10M, EVERY_15M, EVERY_30M, EVERY_1H, EVERY_2H, EVERY_3H, EVERY_6H, EVERY_12H, EVERY_24HArray of public location codes where the URL monitor should run from. Multiple locations provide geographic coverage.Usage:Examples:Use cases: Global performance monitoring, regional compliance, CDN performance validation.
- Global Coverage
- Regional Focus
Whether the URL monitor is enabled and will run according to its schedule.Usage:Examples:
Examples
- Website Availability
- API Health Check
- CDN Performance
- Redirect Chain
- SSL Certificate Check
- Multiple Status Codes
URL monitors only support status code assertions. For more complex assertions on response bodies, headers, or response time, use API checks instead.