API Reference

Event Sentinel API

Integrate Event Sentinel monitoring data directly into your workflows. Our RESTful API provides full access to devices, metrics, predictions, alerts, and analytics.

Overview

The Event Sentinel API is organized around REST principles. It accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and authentication.

Protocol

HTTPS only

Format

JSON

Version

v1 (stable)

Authentication

All API requests require a valid API key sent in the Authorization header using the Bearer scheme. You can generate API keys from your dashboard under Settings > API Keys.

bash

curl https://api.eventsentinel.ai/v1/devices \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Security: Never expose your API key in client-side code. Always make API calls from your server.

Base URL

All API requests should be made to:

https://api.eventsentinel.ai/v1

Devices

Manage and query monitored devices across your infrastructure.

Monitoring

Access real-time and historical monitoring data, AI predictions, and health checks.

Alerts

Configure alert rules, manage notification channels, and query alert history.

Analytics

Access aggregated analytics, reports, and AI-driven insights.

Webhooks

Configure webhook endpoints to receive real-time event notifications.

Error Codes

Event Sentinel uses conventional HTTP status codes. Codes in the 2xx range indicate success, 4xx indicate client errors, and 5xx indicate server errors.

Code	Meaning	Description
200	OK	Request succeeded
201	Created	Resource was created successfully
400	Bad Request	Invalid or missing parameters
401	Unauthorized	Missing or invalid API key
403	Forbidden	Valid key but insufficient permissions
404	Not Found	Resource does not exist
429	Too Many Requests	Rate limit exceeded
500	Internal Server Error	Something went wrong on our end

Error response format

json

{
  "error": {
    "code": "invalid_parameter",
    "message": "The 'status' parameter must be one of: online, offline, warning, critical",
    "param": "status",
    "doc_url": "https://docs.eventsentinel.ai/errors/invalid_parameter"
  }
}

Rate Limits

API requests are rate limited based on your plan. Rate limit information is included in response headers.

Plan	Rate Limit	Burst
Free	60 req/min	10 req/sec
Pro	600 req/min	50 req/sec
Enterprise	6,000 req/min	200 req/sec

Rate limit headers

http

X-RateLimit-Limit: 600
X-RateLimit-Remaining: 594
X-RateLimit-Reset: 1707746160