SENTRY SCADA REST API Documentation

Unified developer reference for programmatic telemetry access, asset status queries, and alarm event streaming across all Sentry SCADA industrial modules.

Introduction

All industrial endpoints are served securely over HTTPS under the root API namespace:

https://sentrydashboard.com/api/v1

Requests and responses enforce JSON serialization (Content-Type: application/json). Timestamps strictly conform to ISO 8601 in UTC format. Numerical metrics follow international engineering units (°C, Amperes, Volts, bar, mm/s).

Authentication

Every programmatic request (excluding initial login) must supply either an API Key or a JWT Bearer Token in the HTTP headers:

1. Industrial API Key (Recommended for SCADA Clients, ERP & Agents)

Provide the pre-shared secret key in the X-API-Key request header:

X-API-Key: sentry_live_xxxxxxxxxxxxxxxxxxxxxxxx

2. JWT Bearer Token (Session Authentication)

Obtained by authenticating via POST /auth/login; valid for 7 days with automatic refresh:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Standard Response Format

Every API response adheres to an envelope schema indicating operation status and payload:

{
  "success": true,
  "message": "Telemetry records retrieved successfully",
  "data": <payload>
}

HTTP Status Codes

POST/auth/login

Exchange engineer or operator credentials for a session JWT bearer token.

Request Body

curl -X POST https://sentrydashboard.com/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"operator","password":"••••••••"}'

Continuous distributed fiber-optic thermometry along conveyors, tunnels, and cable trays. Metric resolutions, sampling intervals, channel counts, and alarm deadbands are fully configurable to match field DTS interrogator hardware and plant geometry.

GET/dts/temperatures/live

Real-time localized temperature readings across mapped fiber segments. Distance offsets and span lengths adapt dynamically to site-specific fiber routing.

curl https://sentrydashboard.com/api/v1/dts/temperatures/live \
  -H "X-API-Key: sentry_live_xxxxxxxx"

Response data[]

GET/dts/segments

Master calibration directory of optical cable segments, zone definitions, and physical plant coordinates (tailored per facility installation).

curl https://sentrydashboard.com/api/v1/dts/segments \
  -H "X-API-Key: sentry_live_xxxxxxxx"

GET/dts/alarms

Retrieve optical hotspot alarm incident logs with custom temperature trigger levels and hysteresis deadbands.

Query Parameters

curl "https://sentrydashboard.com/api/v1/dts/alarms?date=2026-10-12" \
  -H "X-API-Key: sentry_live_xxxxxxxx"

Continuous multi-feeder electrical monitoring supporting intelligent relays, power meters, and variable frequency drives (VFDs). CT/PT ratios, trip thresholds, communication baud rates, and register maps are configured to match specific switchgear lineups.

GET/mcc/feeders/telemetry

Live 3-phase telemetry across designated motor feeder buckets. Additional parameters such as kW, kVAR, THD, and winding RTDs can be added based on protection relay capabilities.

curl https://sentrydashboard.com/api/v1/mcc/feeders/telemetry \
  -H "X-API-Key: sentry_live_xxxxxxxx"

Response data[]

GET/mcc/feeders

Directory of MCC cubicles, breaker ratings, contactor coils, and communication slave IDs configured for the plant.

curl https://sentrydashboard.com/api/v1/mcc/feeders \
  -H "X-API-Key: sentry_live_xxxxxxxx"

GET/mcc/trip-events

Historical log of thermal overloads, short-circuit trips, earth faults, and phase imbalance events with oscillography references.

curl https://sentrydashboard.com/api/v1/mcc/trip-events?limit=50 \
  -H "X-API-Key: sentry_live_xxxxxxxx"

Supervisory telemetry for overland, decline, and plant conveyor systems. Interlock cascades, pre-start warning siren delays, pull-cord switch counts, and chute level triggers are customized according to civil plant topography and material handling flowsheets.

GET/conveyor/lines/status

Real-time belt speed, drive pulley slip percentage, transfer chute blockage detector state, and sequence interlock readiness.

curl https://sentrydashboard.com/api/v1/conveyor/lines/status \
  -H "X-API-Key: sentry_live_xxxxxxxx"

Response data[]

GET/conveyor/interlocks

Status matrix of sequence permissives between feeders, tripper cars, transfer chutes, and stackers.

curl https://sentrydashboard.com/api/v1/conveyor/interlocks \
  -H "X-API-Key: sentry_live_xxxxxxxx"

GET/conveyor/safety-devices

Addressable diagnostic loop status for emergency pull-cord switches, belt misalignment limit switches, and zero-speed sensors.

curl https://sentrydashboard.com/api/v1/conveyor/safety-devices?line=CV-BC4 \
  -H "X-API-Key: sentry_live_xxxxxxxx"

Continuous telemetry for water intake, slurry discharge, cooling loops, and sump pit dewatering. Pressure transmitter spans, cavitation detection thresholds, dual-pump auto-alternation logic, and sump level setpoints are calibrated to site hydraulic specifications.

GET/pumps/stations/telemetry

Live manifold suction and discharge pressures (bar), volumetric flow meters ($m^3/h$), tank levels (%), and duty/standby states.

curl https://sentrydashboard.com/api/v1/pumps/stations/telemetry \
  -H "X-API-Key: sentry_live_xxxxxxxx"

Response data[]

GET/pumps/bearing-vibration

Bearing casing RMS vibration velocity readings (mm/s ISO 10816) and bearing temperature probes (°C).

curl https://sentrydashboard.com/api/v1/pumps/bearing-vibration \
  -H "X-API-Key: sentry_live_xxxxxxxx"

Operational State Codes

License & API Quotas