API Documentation

List of User Devices

Retrieve all devices associated with the authenticated user.

Use Case: Display registered devices on dashboard.

Add New Device Form

Returns form to add a new device (name, type, config).

Use Case: Navigate to “Add Device” screen.

Add New Device

Submits new device data to register it.

Use Case: Save a newly added device.

Edit Device Form

Fetches form to edit a device’s details.

Use Case: Display current settings for editing.

Update Device Details

Updates the device’s details with submitted data.

Use Case: Save changes to an existing device.

Delete Device

Removes a device by its ID.

Use Case: Delete unused devices.

Monitor Device Heartbeat

Checks a device’s heartbeat status.

Use Case: Verify device is active.

Send Device Alert

Gets alert on the device.

Use Case: Test alert mechanism.

Trigger Device Alert

Sends an alert based on conditions.

Use Case: Automated alerts from rules engine.

Test Alert Function

Runs a test of the alert system.

Use Case: Verify alert setup is working.

Reset Device Alarms

Clears all active alarms on a device.

Use Case: Reset after issue resolution.

Check API Health

Returns a simple status message indicating the API is up and running.

Use Case: Automated monitoring or health-check scripts.

API User Login

Authenticates a user and returns a session token.

Use Case: Logging in via external applications.

Body: { "username": "...", "password": "..." }

API User Registration

Creates a new user account.

Use Case: Allow third-party apps to onboard users.

Body: { "username": "...", "password": "..." }

API User Logout

Invalidates the user’s session token.

Use Case: Securely ending sessions from API clients.

Get All User Devices

Lists all devices linked to the authenticated user.

Use Case: External dashboards or scripts.

Add a New Device

Registers a new device for the user.

Use Case: Programmatically add devices.

Update Device Details

Modifies details of a specific device.

Use Case: Automated device configuration updates.

Delete Device

Removes a device by ID.

Use Case: Cleanup unused devices.

Receive Heartbeat Signal

Logs a heartbeat from a device.

Use Case: Device health monitoring.

Trigger Device Alert

Sends a manual alert to a device.

Use Case: External alert integrations.

Reset Device Alarms

Clears active alarms for a device.

Use Case: Automated alarm resets after issues resolved.

View Heartbeat Logs

Retrieve all heartbeat events from monitored devices, including timestamp, device ID, and status.

Use Case: Audit device uptime and connectivity history.

View Alert Logs

Fetch a log of all triggered alerts, showing alert type, device ID, timestamp, and message.

Use Case: Diagnose past alerts for troubleshooting or compliance.

View Specific Device Logs

Retrieve combined heartbeat and alert logs for one device, identified by ID.

Use Case: Analyze the full event history of a particular device.

Page Not Found

Returns a custom 404 page when the requested resource does not exist.

Use Case: Inform users they’ve navigated to an invalid URL.

Internal Server Error

Displays a 500 error page when an unexpected server error occurs.

Use Case: Notify users of server-side failures and next steps.

Access Denied

Shows a 403 page when the user lacks permission to view a resource.

Use Case: Prevent unauthorized access to restricted pages.