API Reference

DOCS

REST API

Use the HowlOps REST API to automate monitoring, integrate with your CI/CD pipeline, or build custom dashboards. Base URL: https://api.howlops.com/api/v1

Authentication

All API requests require a Bearer token. Generate an API key under Settings → API Keys.

curl -H "Authorization: Bearer YOUR_API_KEY" \\
https://api.howlops.com/api/v1/monitors

Endpoints

Method	Endpoint	Description	Plan
GET	/monitors	List all monitors	All
POST	/monitors	Create a monitor	All
GET	/monitors/{id}	Get monitor details (includes status)	All
PUT	/monitors/{id}	Update a monitor	All
DELETE	/monitors/{id}	Delete a monitor	All
GET	/heartbeats	List heartbeats	All
POST	/heartbeats	Create a heartbeat	All
GET	/hb/{slug}	Send a heartbeat ping (public, GET/POST/HEAD)	All
POST	/hb/{slug}	Send a heartbeat ping (public)	All
GET	/incidents	List incidents	All
GET	/incidents/{id}	Get incident details	All
GET	/analytics	Uptime and response-time stats	Paid
GET	/analytics/sla-report	SLA report for date range	Paid
GET	/analytics/monitor-breakdown	Per-monitor breakdown	Paid

Create a monitor

curl -X POST https://api.howlops.com/api/v1/monitors \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "My API", "url": "https://api.example.com/health", "type": "http", "interval": 60, "alert_threshold": 2 }'

Heartbeat ping

Heartbeat pings use a public endpoint. No authentication required:

curl https://api.howlops.com/api/v1/hb/YOUR_HEARTBEAT_SLUG

Rate limits

100 requests/minute (all plans)
Headers: X-RateLimit-Remaining, X-RateLimit-Reset

API responses follow the format: { "items": [...], "total": N, "page": 1 } for list endpoints. Error responses: { "error": "message", "code": "ERROR_CODE" }