Controller Reference
Edge exposes 63 REST API controllers accessible through Swagger UI. The table below groups them by category.
Core entities
Section titled “Core entities”| Controller | Description |
|---|---|
device-controller | CRUD operations on devices, assign to customers/tenants, search |
asset-controller | CRUD operations on assets, assign to customers |
entity-view-controller | Create and manage entity views |
entity-relation-controller | Create, query, and delete relations between entities |
customer-controller | Manage customers, assign sub-entities |
user-controller | Manage users, activation links |
dashboard-controller | CRUD for dashboards, assign to customers, import/export |
device-profile-controller | Manage device profiles (transport, alarm rules, provisioning) |
asset-profile-controller | Manage asset profiles |
Telemetry & attributes
Section titled “Telemetry & attributes”| Controller | Description |
|---|---|
telemetry-controller | Save/read/delete attributes and time series for any entity |
entity-query-controller | Query entities with filters, pagination, and data aggregation |
Alarms
Section titled “Alarms”| Controller | Description |
|---|---|
alarm-controller | Create, acknowledge, clear, assign, and query alarms |
alarm-query-controller | Query alarms with entity filters, severity, status, and time range |
alarm-comment-controller | Add, update, and delete alarm comments |
| Controller | Description |
|---|---|
rpc-v-2-controller | Send one-way/two-way RPC to devices, manage persistent RPCs |
rpc-v-1-controller | Deprecated — use rpc-v-2-controller |
Rule engine
Section titled “Rule engine”| Controller | Description |
|---|---|
rule-chain-controller | CRUD for rule chains, import/export, set root chain |
rule-engine-controller | Push messages to the rule engine for a specific entity |
Calculated fields
Section titled “Calculated fields”| Controller | Description |
|---|---|
calculated-field-controller | Create and manage calculated fields, test expressions |
Administration
Section titled “Administration”| Controller | Description |
|---|---|
admin-controller | System settings (mail, SMS, general) |
tenant-controller | Manage tenants |
tenant-profile-controller | Manage tenant profiles (rate limits, quotas) |
auth-controller | Password reset, change password, user activation |
login-endpoint | Login (JWT), token refresh |
queue-controller | Manage processing queues |
queue-stats-controller | View queue statistics |
audit-log-controller | Query audit logs (by user, entity, or tenant) |
usage-info-controller | Get tenant API usage info |
auto-commit-controller | Manage version-control auto-commit settings |
job-controller | Monitor and manage background jobs |
system-info-controller | Get system information |
Security
Section titled “Security”| Controller | Description |
|---|---|
api-key-controller | Create, enable/disable, and delete API keys |
two-factor-auth-controller | 2FA verification (send/check codes, login with 2FA) |
two-factor-auth-config-controller | Configure 2FA providers and account settings |
o-auth-2-controller | Manage OAuth2 clients and login settings |
domain-controller | Manage custom domains and OAuth2 client assignments |
mail-config-template-controller | Manage mail configuration templates |
o-auth-2-config-template-controller | Manage OAuth2 configuration templates |
Notifications
Section titled “Notifications”| Controller | Description |
|---|---|
notification-controller | Send notifications, mark as read, get notification feed |
notification-rule-controller | Manage notification rules (triggers) |
notification-target-controller | Manage notification targets (recipients) |
notification-template-controller | Manage notification templates |
Device connectivity
Section titled “Device connectivity”| Controller | Description |
|---|---|
device-connectivity-controller | Get connectivity commands and download certificates |
lwm-2m-controller | LwM2M bootstrap security info |
OTA updates & resources
Section titled “OTA updates & resources”| Controller | Description |
|---|---|
ota-package-controller | Upload and manage firmware/software OTA packages |
tb-resource-controller | Upload and manage platform resources (LwM2M models, files) |
image-controller | Upload, update, and serve images |
Widgets & UI
Section titled “Widgets & UI”| Controller | Description |
|---|---|
widgets-bundle-controller | Manage widget bundles |
widget-type-controller | Manage individual widget types |
ui-settings-controller | Get UI configuration |
qr-code-settings-controller | Manage QR code and mobile app settings |
Mobile
Section titled “Mobile”| Controller | Description |
|---|---|
mobile-app-controller | Manage mobile app configurations |
mobile-app-bundle-controller | Manage mobile app bundles |
Version control
Section titled “Version control”| Controller | Description |
|---|---|
entities-version-control-controller | Save/load entity versions, compare, list branches |
| Controller | Description |
|---|---|
component-descriptor-controller | Browse available rule node components |
event-controller | Query rule engine events (errors, debug, lifecycle) |
ai-model-controller | Manage AI model configurations |
Edge-specific
Section titled “Edge-specific”| Controller | Description |
|---|---|
edge-controller | Manage Edge instances, assign entities to Edge |
edge-event-controller | Query edge sync events (uplink/downlink history between Edge and server) |
Was this helpful?
Thank you for your feedback!