RESTful API for programmatic access to PulseOps
The PulseOps API uses API keys for authentication. Include your API key in the Authorization header:
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.pulseop.net/v1/monitorsGenerate API keys in your dashboard under Settings → API Keys.
API requests are rate-limited based on your plan:
Rate limit headers are included in all responses:
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1642584000Retrieve all monitors in your account.
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.pulseop.net/v1/monitors{
"data": [
{
"id": "mon_abc123",
"name": "API Health Check",
"url": "https://api.example.com/health",
"type": "http",
"interval": 60,
"status": "up",
"created_at": "2026-01-01T00:00:00Z"
}
],
"pagination": {
"page": 1,
"per_page": 20,
"total": 45
}
}curl -X POST \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "API Health Check",
"url": "https://api.example.com/health",
"type": "http",
"interval": 60
}' \
https://api.pulseop.net/v1/monitorsRetrieve incidents with optional filters.
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://api.pulseop.net/v1/incidents?status=open"status - Filter by status (open, resolved, investigating)monitor_id - Filter by monitor IDfrom - Start date (ISO 8601)to - End date (ISO 8601){
"channel": "email",
"recipient": "alerts@example.com",
"config": {
"smtpHost": "smtp.gmail.com",
"smtpPort": 587,
"smtpUser": "user@example.com",
"smtpPassword": "password"
}
}{
"name": "Production Services",
"slug": "production",
"isPublic": true,
"config": {
"monitorIds": ["mon_abc123", "mon_def456"]
}
}The API uses standard HTTP status codes and returns errors in JSON format:
{
"error": {
"code": "invalid_request",
"message": "The request parameters are invalid",
"details": {
"field": "url",
"issue": "Must be a valid URL"
}
}
}