Gas Vigil LogoGasVigil
Sign InSign Up

Documentation

Explore modules, APIs, data models, and usage guides for building with GasVigil. This overview links to the most important concepts and endpoints.

API Overview

RESTful APIs with JWT authentication and role-based access. Real-time updates via WebSockets. Visit Swagger for full endpoint details.

Open Swagger Docs

IoT Device Data

  • POST /api/iot-device-data to submit sensor data
  • POST /api/iot-device-data/alert-data for status code-based alerts
  • GET /api/iot-device-data/device/:deviceId for historical data
  • GET /api/iot-device-data/device/:deviceId/latest for latest entry

Alerts & Tickets

  • GET /api/alerts with filters for type, severity, status
  • PUT /api/alerts/:id/acknowledge and /resolve workflows
  • GET /api/tickets and endpoints for acknowledgment and resolution

Security & Auth

JWT tokens, MFA support, role-based permissions, and secure transport.

Data Models

Structured models for locations, devices, sensors, alerts, and tickets optimized for reporting and scalability.

Exports & Reports

Generate CSV exports and analytics across alerts, tickets, and device health.