sfsEdgeStore

API Reference

Complete REST API documentation for sfsEdgeStore.

Base URL

http://localhost:8081

Health & Status

Health Check

GET /health
GET /healthz

Response:

{
  "status": "healthy",
  "version": "1.0.0",
  "uptime": "1h23m45s"
}

Readiness Check

GET /ready

System Status

GET /api/status

Resource Status

GET /api/resources/status

Metrics (Prometheus format)

GET /metrics

Data API

Query Readings

GET /api/readings

Parameter	Type	Required	Description
deviceName	string	No	Filter by device name
startTime	string	No	ISO 8601 timestamp
endTime	string	No	ISO 8601 timestamp
limit	int	No	Limit result count

Example:

curl "http://localhost:8081/api/readings?deviceName=Device001&limit=10"

Response:

{
  "count": 10,
  "readings": [...]
}

Device Status

GET /api/device-status

Configuration API

Get Configuration

GET /api/config/get

Update Configuration

POST /api/config/update

Reload Configuration

POST /api/config/reload

One-Click Configuration

POST /api/config/oneclick

Backup & Restore

Create Backup

POST /api/backup

Parameter	Type	Description
path	string	Backup directory (default: ./backups)

Restore from Backup

POST /api/restore

Parameter	Type	Required	Description
file	string	Yes	Path to backup file

Data Export/Import

Export CSV

GET /api/export/csv

Export JSON

GET /api/export/json

Export SQL

GET /api/export/sql

Import CSV

POST /api/import/csv

Import JSON

POST /api/import/json

Monitoring & Alerts

Subscription Status

GET /api/subscription/status

Test Subscription

POST /api/subscription/test

Subscription Themes

GET /api/subscription/themes

Alerts

GET /api/alerts

Alert Groups

GET /api/alert-groups

Alert Notifier Status

GET /api/alerts/notifier/status

Test Alert

POST /api/alerts/test

Data Retention

Retention Status

GET /api/retention/status

Manual Cleanup

POST /api/retention/cleanup

Templates

List Templates

GET /api/templates

Apply Template

POST /api/templates/apply

Body:

{
  "industry": "motor"
}

Baselines

List Baselines

GET /api/baselines

Calculate Baseline

POST /api/baselines/calculate

Body:

{
  "deviceName": "temperature-sensor-001",
  "readingName": "temperature"
}

Authentication

Create API Key

POST /api/auth/create-key

List API Keys

GET /api/auth/list-keys

Revoke API Key

POST /api/auth/revoke-key

Encryption

Encryption Status

GET /api/encryption/status

Rotate Encryption Key

POST /api/encryption/rotate-key

License

License Information

GET /api/license

MQTT Configuration

Update MQTT Configuration

POST /api/config/mqtt

WebSocket

Real-time Data Stream

WS /ws

Connect via WebSocket for real-time data streaming.

This site is open source. Improve this page.