Skip to content

Table of Contents

Every documented endpoint, in the same order as the navigation. Paths are relative to the base URL https://spoilerinterface.com/interface. See Usage and response handling for the auth modes.

General endpoints

Method Path Endpoint Auth
GET /test Test None
GET /version Version None
GET /info/countries Countries None
GET /packages Packages api_key
GET /bundles Bundles None

Sign up

Method Path Endpoint Auth
POST /signup Sign up None
POST /verification Verify email None

Authentication

Method Path Endpoint Auth
POST /login Login None
POST /logout Logout api_key
Method Path Endpoint Auth
GET /2fa/status 2FA status api_key
POST /2fa/enable Enable 2FA api_key
POST /2fa/disable Disable 2FA api_key
POST /2fa/send Resend 2FA code None
POST /2fa/verify Verify 2FA code None
POST /login/magic Send magic link None
POST /login/magic/consume Consume magic link None

Password

Method Path Endpoint Auth
POST /send_reset_password_link Send reset password link None
POST /reset_password Reset password None
POST /update/password Change password api_key

Auth test

Method Path Endpoint Auth
GET /home Home api_key

User Profile

Method Path Endpoint Auth
GET /user/profile Get profile api_key
POST /update/profile Update profile api_key
POST /update/profile/offset Update time offset api_key
GET /cellphone/gen_verification_code Generate cellphone verification code api_key
POST /cellphone/verification Verify cellphone api_key
GET /sessions List sessions api_key
POST /sessions/logout Log out a session api_key
GET /stats Stats api_key

Sensor

Method Path Endpoint Auth
POST /add/sensor Add sensor api_key
GET /sensor/count Sensor count api_key
GET /sensor/list List sensors api_key
GET /sensor/status Sensor status Device id + token
POST /update/sensor Update sensor Device id + token
GET /sensor/history Sensor history api_key
POST /edit/sensor Edit sensor api_key
POST /delete/sensor Delete sensor api_key
POST /notifications/{device_type}/{alert_type}/{action} Notification settings api_key and device id + token

Switch

Method Path Endpoint Auth
POST /add/switch Add switch api_key
GET /switch/count Switch count api_key
GET /switch/list List switches api_key
GET /switch/status Switch status Device id + token
POST /update/switch Update switch Device id + token
POST /request/switch/state Request switch state Device id + token
GET /switch/history Switch history api_key
POST /edit/switch Edit switch api_key
POST /delete/switch Delete switch api_key
POST /notifications/{device_type}/{alert_type}/{action} Notification settings api_key and device id + token

GPS

Method Path Endpoint Auth
POST /add/gps Add GPS device api_key
GET /gps/count GPS count api_key
GET /gps/list List GPS devices api_key
GET /gps/status GPS status Device id + token
POST /update/gps Update GPS device Device id + token
GET /gps/history GPS history api_key
POST /edit/gps Edit GPS device api_key
POST /delete/gps Delete GPS device api_key
POST /notifications/{device_type}/{alert_type}/{action} Notification settings api_key and device id + token

Battery monitor

Method Path Endpoint Auth
POST /add/batmon Add battery monitor api_key
GET /batmon/count Battery monitor count api_key
GET /batmon/list List battery monitors api_key
GET /batmon/status Battery monitor status Device id + token
POST /update/batmon Update battery monitor Device id + token
PUT /batmon Update battery monitor Device id + token
GET /batmon/history Battery monitor history api_key
POST /edit/batmon Edit battery monitor api_key
POST /delete/batmon Delete battery monitor api_key
POST /notifications/{device_type}/{alert_type}/{action} Notification settings api_key and device id + token

Meteorological

Method Path Endpoint Auth
POST /add/met Add meteorological station api_key
GET /met/count Meteorological station count api_key
GET /met/list List meteorological stations api_key
GET /met/status Meteorological station status Device id + token
POST /update/met Update meteorological station Device id + token
GET /met/history Meteorological station history api_key
POST /edit/met Edit meteorological station api_key
POST /delete/met Delete meteorological station api_key
POST /notifications/{device_type}/{alert_type}/{action} Notification settings api_key and device id + token

Workstation

Method Path Endpoint Auth
POST /add/ws Add workstation api_key
GET /ws/count Workstation count api_key
GET /ws/list List workstations api_key
GET /ws/status Workstation status Device id + token
POST /update/ws Update workstation Device id + token
GET /ws/history Workstation history api_key
POST /edit/ws Edit workstation api_key
POST /delete/ws Delete workstation api_key
POST /notifications/{device_type}/{alert_type}/{action} Notification settings api_key and device id + token

Ping

Method Path Endpoint Auth
POST /add/device Add device api_key
GET /device/count Device count api_key
GET /device/list List devices api_key
GET /device/status Device status Device id + token
POST /update/device Update device Device id + token
GET POST /device/history Device history api_key
POST /edit/device Edit device api_key
POST /delete/device Delete device api_key
POST /notifications/{device_type}/{alert_type}/{action} Notification settings api_key and device id + token

Dynamic interfaces

Method Path Endpoint Auth
POST /dynamic Add dynamic interface api_key
PUT /dynamic Edit dynamic interface api_key
GET /dynamic List dynamic interfaces api_key
DELETE /dynamic Delete dynamic interface api_key
GET /dynamic/interface/{interface_url} Get interface data api_key
POST /dynamic/interface/{interface_url} Push interface data None

Alarms

Method Path Endpoint Auth
GET /alarm Get alarms api_key
POST /add/alarm Add alarm api_key
POST /edit/alarm Edit alarm api_key
POST /delete/alarm Delete alarm api_key
POST /enable/alarm Enable alarm None
POST /disable/alarm Disable alarm None

Notifications

Method Path Endpoint Auth
GET /notification/history Notification history api_key
POST /notifications/{device_type}/{alert_type}/{action} Enable or disable alerts api_key and Device id + token

MQTT

Method Path Endpoint Auth
GET /mqtt/topics List topics api_key
GET /mqtt/status Broker status api_key
GET /mqtt/live Live messages api_key; device must be owned by the caller
POST /mqtt/topic Create topic api_key; device must be owned by the caller
DELETE /mqtt/topic Delete topic api_key; device must be owned by the caller
POST /mqtt/publish Publish api_key; device must be owned by the caller
WS /ws/mqtt/live WebSocket live view api_key; device must be owned by the caller

User settings

Method Path Endpoint Auth
GET /user/settings Get settings api_key
POST /update/settings Update settings api_key

Reports

Method Path Endpoint Auth
GET /reports/list List reports api_key
POST /reports/generate Generate report api_key
GET /reports/view/{report_id} View report api_key
GET /reports/share/{report_id} Share report api_key
POST /reports/delete Delete report api_key
GET /reports/shared/{token} Shared report (public) None
POST /report Generate report (legacy) api_key
GET /reports/ List reports (legacy) api_key

Device sharing

Method Path Endpoint Auth
GET /share Get share link api_key
GET /share/all List share links api_key
POST /share Share device api_key; the device must belong to the caller
PUT /share Update share link api_key; only the device owner can edit
DELETE /share Delete share link api_key; only the device owner can delete
GET /share/data Shared device data None
GET /shared/view/{token} Shared view (public page) None

Invoices & billing

Method Path Endpoint Auth
GET /invoices/info Get invoices api_key
GET /invoices/info/{invoice_id} Get invoice api_key
GET /invoices/pay/{invoice_id} Pay invoice None
GET /invoices/return Payment return None
GET /invoices/cancel Payment cancel None