API Reference

REST API documentation for the Iconet Gateway.

Base URL

http://<gateway-ip>/api/v1

Authentication

All API requests require a Bearer token:

Authorization: Bearer <your-api-token>

Generate a token from Settings → API → Generate Token in the dashboard.

Endpoints

Get All Devices

GET /api/v1/devices

Returns a list of all configured devices.

Get Device Status

GET /api/v1/devices/:id

Returns the current status of a specific device.

Control Device

POST /api/v1/devices/:id/command
Content-Type: application/json

{
  "action": "set",
  "value": 75
}

List Scenes

GET /api/v1/scenes

Activate Scene

POST /api/v1/scenes/:id/activate

WebSocket API

For real-time updates, connect to the WebSocket endpoint:

ws://<gateway-ip>/api/v1/ws

Events are pushed as JSON messages when device states change.

Rate Limits

  • REST API: 100 requests/minute
  • WebSocket: Unlimited (event-driven)
API Reference - Iconet — Modernize Your Vantage & Home Automation System