Controller Reference
Edge 4.4 exposes about 90 REST API controllers through Swagger UI, almost the same set as the ThingsBoard server. The tables below group 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-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 |
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 |
Groups, roles, and permissions
Section titled “Groups, roles, and permissions”| Controller | Description |
|---|---|
entity-group-controller |
Manage entity groups and their members, and assign groups to the Edge |
group-permission-controller |
Manage group permissions: which user group has which role on which entity group |
role-controller |
Manage generic and group roles |
owner-controller |
Change the owner (tenant or customer) of an entity |
user-permissions-controller |
Read the permissions of the current user |
Integrations
Section titled “Integrations”| Controller | Description |
|---|---|
integration-controller |
Manage integrations and check missing Edge attributes used in integration templates |
converter-controller |
Manage data converters and test uplink and downlink scripts |
converter-library-controller |
Browse the converter library by vendor and model |
Reports and scheduler
Section titled “Reports and scheduler”| Controller | Description |
|---|---|
scheduler-event-controller |
Manage scheduler events and their assignment to the Edge |
report-controller |
Generate and download reports |
report-template-controller |
Manage report templates |
dashboard-report-controller |
Generate a report from a dashboard |
blob-entity-controller |
Read stored files such as generated reports |
White labeling and customization
Section titled “White labeling and customization”| Controller | Description |
|---|---|
white-labeling-controller |
Read and save white-labeling settings for the UI and the login page |
custom-menu-controller |
Manage custom menus |
custom-translation-controller |
Manage custom translations |
translation-controller |
Read available locales and translations |
self-registration-controller |
Self-registration settings |
sign-up-controller |
Sign-up and email activation |
Agents
Section titled “Agents”| Controller | Description |
|---|---|
agent-controller |
Manage Remote Agents |
agent-profile-controller |
Manage agent profiles |
agent-application-controller |
Manage applications deployed by agents and their events |
agent-app-profile-controller |
Manage application profiles |
agent-app-template-controller |
Read application templates |
agent-bulk-action-controller |
Track bulk actions on agents |
AI and analytics
Section titled “AI and analytics”| Controller | Description |
|---|---|
ai-chat-controller |
AI assistant chats |
ai-device-dashboard-controller |
Generate a device dashboard with AI |
ai-solution-controller |
AI solution creator |
ai-tool-controller |
Approve AI tool calls |
trendz-controller, trendz-api-controller |
Trendz Analytics connection and usage |
Alarm rules, secrets, and device API
Section titled “Alarm rules, secrets, and device API”| Controller | Description |
|---|---|
alarm-rule-controller |
Manage alarm rules and test their scripts |
secret-controller |
Manage secrets in the secrets storage |
device-group-ota-package-controller |
Assign OTA packages to device groups |
solution-export-import-controller |
Export and import solutions |
device-api-controller |
Device HTTP API: telemetry, attributes, RPC, and provisioning (/api/v1/...) |
login-endpoint |
Log in and refresh tokens (/api/auth/login, /api/auth/token) |
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!