Creating a Health Check
- Go to Health Checks in the dashboard
- Click Add Health Check
- Fill in the details:
| Field | Description | Example |
|---|---|---|
| Name | Display name | Production API |
| URL | Full URL to check | https://api.example.com/health |
| Method | HTTP method | GET, POST, HEAD |
| Interval | Check frequency | 30 (seconds) |
| Timeout | Max response time | 10 (seconds) |
- Click Create
How It Works
Every interval, we:- Send an HTTP request to your URL
- Record response time and status code
- Mark as UP if status is 2xx, DOWN otherwise
- Send alert if status changes
Alert Behavior
- First failure: Wait and retry
- Confirmed down: Send alert after multiple failures
- Recovery: Send “back up” notification
We use confirmation checks to avoid false alerts from temporary network issues.
Expected Status Codes
By default, 2xx responses are considered healthy. You can customize:| Expected | Behavior |
|---|---|
200 | Only 200 is healthy |
200,201 | 200 or 201 is healthy |
2xx | Any 200-299 is healthy |
Keyword Matching
Optionally check that the response contains specific text:| Field | Description |
|---|---|
| Keyword | Text to find in response |
| Mode | contains or not_contains |
"status":"ok".
Retry Settings
| Setting | Description | Default |
|---|---|---|
| Retries | Number of retry attempts | 3 |
| Retry Interval | Seconds between retries | 10 |
Uptime Statistics
For each health check, you’ll see:- 24h Uptime: Last 24 hours
- 7d Uptime: Last 7 days
- 30d Uptime: Last 30 days
- Response Time: Average, min, max
Public Status Pages
Requires PRO plan
- Go to the health check settings
- Enable “Public Status Page”
- Copy the public URL
Incidents
When a health check fails, an incident is created:- Start time
- Error message or status code
- Duration (when recovered)
Best Practices
What endpoint should I monitor?
What endpoint should I monitor?
Create a
/health endpoint that checks critical dependencies:How often should I check?
How often should I check?
- Critical services: Every 30 seconds
- Regular websites: Every 60 seconds
- Non-critical: Every 5 minutes
What timeout should I use?
What timeout should I use?
Set timeout higher than your typical response time. If your API responds in 500ms, use 5-10s timeout.
Limits
| Plan | Health Checks |
|---|---|
| Free | 3 |
| PRO | Unlimited |