Skip to content

Permissions ​

Access to REST API endpoints requires an access token that includes the corresponding permission. This page lists all permissions and their applicable endpoints.

Permission List ​

ScopeTypePurpose
device:readRead-onlyList devices, get device detail, get device configuration, list device profiles, and get command results
device:controlCommand writeIncludes all device:read permissions, plus the ability to send relay, RS485, and other operation commands to devices
device:configConfig writeIncludes all device:read permissions, plus the ability to modify device parameter configuration
device:manageManagementIncludes all device:read permissions, plus the ability to add devices, remove devices, and modify device passwords

Endpoint Requirements ​

EndpointRequired PermissionStatus
GET /wlte/v1/devicesdevice:readAvailable
GET /wlte/v1/devices/{deviceId}device:readAvailable
GET /wlte/v1/devices/{deviceId}/configdevice:readAvailable
GET /wlte/v1/device-profilesdevice:readAvailable
GET /wlte/v1/commands/{commandId}device:readAvailable
POST /wlte/v1/devices/{deviceId}/relays/commandsdevice:controlAvailable
POST /wlte/v1/devices/{deviceId}/relays/{index}/commandsdevice:controlCompatibility endpoint, planned for removal
POST /wlte/v1/devices/{deviceId}/rs485/transceivedevice:controlAvailable
PUT /wlte/v1/devices/{deviceId}/rs485/baud-ratedevice:configAvailable
PUT /wlte/v1/devices/{deviceId}/relays/{index}/jog-configdevice:configAvailable
POST /wlte/v1/devicesdevice:manageAvailable
DELETE /wlte/v1/devices/{deviceId}device:manageAvailable
PUT /wlte/v1/devices/{deviceId}/passworddevice:manageAvailable

Access Boundaries ​

  • device:control, device:config, and device:manage all include the full permissions of device:read; no need to also grant device:read
  • device:control, device:config, and device:manage are independent; grant each based on integration requirements
  • When querying command results, a client can only access commands under devices it is authorized to access
  • Missing, invalid, or expired authentication returns 401
  • Valid authentication with insufficient permission returns 403 AUTH_SCOPE_DENIED
Docs buildVersion v1.6.3-20261020-171545-90
Copyright © 2026 WLTE