Skip to content

REST API License Requirements

Document Context

  • Purpose: Documents which REST endpoints require an active Plus or higher license and how the firmware behaves when the license is missing
  • When to use: Integration planning, troubleshooting 404 License required, choosing device edition, validating feature availability before deployment
  • Prerequisites: Basic familiarity with REST endpoints and HTTP status codes
  • Related to: License & editions, REST reference, System Info
  • Validates against: Firmware route registration in the device HTTP server

Key Facts

  • License scope: Only part of the REST API is gated; the rest of the device configuration API remains available without Plus
  • Required tier: Plus or higher
  • Firmware behavior: Gated routes return 404 License required using the original HTTP method of the endpoint
  • How to verify: Check .device.license.type in /api/v1/system
  • Maintenance model: One central list is used here and linked from endpoint pages
  • Scope note: This page covers REST only; MQTT and selected runtime services are listed on the license overview page

Endpoints Requiring Plus Or Higher

The REST endpoints below are available only with an active Plus or higher license. On devices reporting FREE, these routes return 404 License required.

Endpoint Methods Purpose
/api/v1/report GET Latest parsed energy and meter report
/api/v1/report/objects GET Raw DLMS/COSEM object list
/api/v1/variables GET MQTT/template variables exposed over REST
/api/v1/actions GET, POST, DELETE Actions definition management
/api/v1/actions/call POST Action execution
/api/v1/actions/status GET Action execution status

How To Check License State

Check the license type in:

  • GET /api/v1/system: inspect .device.license.type

If the device reports FREE, the endpoint groups listed above are not available.

What Happens Without The Required License

Without Plus or higher, the endpoints listed above are not available and return 404 License required.

Integration Guidance

  • For a universal connectivity check, use /api/v1/system
  • Use /api/v1/report only when Plus or higher is confirmed
  • If your integration depends on reports, variables, or actions, treat Plus as a prerequisite