How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Viridi Parente

Viridi ViSTA Platform API

The REST API of ViSTA (Viridi Insights), Viridi's energy management and IIoT platform. ViSTA is a Viridi-operated deployment of the open-source ThingsBoard IoT platform (v3.7.0) served from vista.viridiparente.com, extended with Viridi-authored controllers: SBR30 battery telemetry and data, generator and chiller latest-value reads, CBRS device registration and configuration, and Moxion AEMP equipment telematics and fault feeds. All operations require an authenticated ViSTA account; the OpenAPI contract itself is served anonymously.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 455 operations across 373 paths, organized into 56 resource areas, and defines 425 schemas. It is described by OpenAPI 3.1.0, at version 3.7.0.

Requests are made against a single base URL, https://vista.viridiparente.com.

455 operations 373 paths 425 schemas 54 DELETE252 GET1 HEAD1 OPTIONS1 PATCH136 POST10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.7.0
Base URL
https://vista.viridiparente.com
Authentication
HTTP Loginpassword
Contact
ThingsBoard team
License
Apache License Version 2.0
Resource Areas
56

Authentication & Security 1

Viridi ViSTA Platform API declares 1 security scheme for authenticating requests. It uses HTTP loginpassword authentication (HTTP login form).

  • HTTP login form — Enter Username / Password

Paths & Operations 455

Across 373 paths, the API surfaces 455 operations — 54 DELETE, 252 GET, 1 HEAD, 1 OPTIONS, 1 PATCH, 136 POST, 10 PUT. They span 56 resource areas, including login-endpoint, user-controller, notification-controller, image-controller, two-factor-auth-config-controller, widgets-bundle-controller, widget-type-controller, tenant-controller, and 48 more. Each is listed below with its method, path, parameters, and response codes.

login-endpoint 1
POST
/api/auth/login
Login method to get user JWT token data
body → 200401401
user-controller 25
GET
/api/user/settings
Get user settings (getUserSettings)
getUserSettings → 200
PUT
/api/user/settings
Update user settings (saveUserSettings)
putUserSettings body → 200
POST
/api/user/settings
Save user settings (saveUserSettings)
saveUserSettings body → 200
GET
/api/user/settings/{type}
Get user settings (getUserSettings)
getUserSettings_1 1 param → 200
PUT
/api/user/settings/{type}
Update user settings (saveUserSettings)
putUserSettings_1 1 param body → 200
POST
/api/user
Save Or update User (saveUser)
saveUser 1 param body → 200
POST
/api/user/{userId}/userCredentialsEnabled
Enable/Disable User credentials (setUserCredentialsEnabled)
setUserCredentialsEnabled 2 params → 200
POST
/api/user/sendActivationMail
Send or re-send the activation email
sendActivationEmail 1 param → 200
GET
/api/user/mobile/session
getMobileSession 1 param → 200
POST
/api/user/mobile/session
saveMobileSession 1 param body → 200
DELETE
/api/user/mobile/session
removeMobileSession 1 param → 200
GET
/api/users
Get Users (getUsers)
getUsers 5 params → 200
GET
/api/users/info
Find users by query (findUsersByQuery)
findUsersByQuery 5 params → 200
GET
/api/users/assign/{alarmId}
Get usersForAssign (getUsersForAssign)
getUsersForAssign 6 params → 200
GET
/api/user/{userId}
Get User (getUserById)
getUserById 1 param → 200
DELETE
/api/user/{userId}
Delete User (deleteUser)
deleteUser 1 param → 200
GET
/api/user/{userId}/token
Get User Token (getUserToken)
getUserToken 1 param → 200
GET
/api/user/{userId}/activationLink
Get the activation link (getActivationLink)
getActivationLink 1 param → 200
GET
/api/user/tokenAccessEnabled
Check Token Access Enabled (isUserTokenAccessEnabled)
isUserTokenAccessEnabled → 200
GET
/api/user/dashboards
Get information about last visited and starred dashboards (getLastVisitedDashboards)
getUserDashboardsInfo → 200
GET
/api/user/dashboards/{dashboardId}/{action}
Report action of User over the dashboard (reportUserDashboardAction)
reportUserDashboardAction 2 params → 200
GET
/api/tenant/{tenantId}/users
Get Tenant Users (getTenantAdmins)
getTenantAdmins 6 params → 200
GET
/api/customer/{customerId}/users
Get Customer Users (getCustomerUsers)
getCustomerUsers 6 params → 200
DELETE
/api/user/settings/{type}/{paths}
Delete user settings (deleteUserSettings)
deleteUserSettings 2 params → 200
DELETE
/api/user/settings/{paths}
Delete user settings (deleteUserSettings)
deleteUserSettings_1 1 param → 200
notification-controller 15
PUT
/api/notifications/read
Mark all notifications as read (markAllNotificationsAsRead)
markAllNotificationsAsRead 1 param → 200
PUT
/api/notification/{id}/read
Mark notification as read (markNotificationAsRead)
markNotificationAsRead 1 param → 200
GET
/api/notification/settings
Get notification settings (getNotificationSettings)
getNotificationSettings → 200
POST
/api/notification/settings
Save notification settings (saveNotificationSettings)
saveNotificationSettings body → 200
GET
/api/notification/settings/user
getUserNotificationSettings → 200
POST
/api/notification/settings/user
saveUserNotificationSettings body → 200
POST
/api/notification/request
Create notification request (createNotificationRequest)
createNotificationRequest body → 200
POST
/api/notification/request/preview
Get notification request preview (getNotificationRequestPreview)
getNotificationRequestPreview 1 param body → 200
GET
/api/notifications
Get notifications (getNotifications)
getNotifications 7 params → 200
GET
/api/notifications/unread/count
Get unread notifications count (getUnreadNotificationsCount)
getUnreadNotificationsCount 1 param → 200
GET
/api/notification/requests
Get notification requests (getNotificationRequests)
getNotificationRequests 5 params → 200
GET
/api/notification/request/{id}
Get notification request by id (getNotificationRequestById)
getNotificationRequestById 1 param → 200
DELETE
/api/notification/request/{id}
Delete notification request (deleteNotificationRequest)
deleteNotificationRequest 1 param → 200
GET
/api/notification/deliveryMethods
Get available delivery methods (getAvailableDeliveryMethods)
getAvailableDeliveryMethods → 200
DELETE
/api/notification/{id}
Delete notification (deleteNotification)
deleteNotification 1 param → 200
image-controller 12
GET
/api/images/{type}/{key}
downloadImage 3 params → 200
PUT
/api/images/{type}/{key}
updateImage 2 params body → 200
DELETE
/api/images/{type}/{key}
deleteImage 3 params → 200
PUT
/api/images/{type}/{key}/public/{isPublic}
updateImagePublicStatus 3 params → 200
GET
/api/images/{type}/{key}/info
getImageInfo 2 params → 200
PUT
/api/images/{type}/{key}/info
updateImageInfo 2 params body → 200
PUT
/api/image/import
importImage body → 200
POST
/api/image
uploadImage body → 200
GET
/api/images
getImages 6 params → 200
GET
/api/images/{type}/{key}/preview
downloadImagePreview 3 params → 200
GET
/api/images/{type}/{key}/export
exportImage 2 params → 200
GET
/api/images/public/{publicResourceKey}
downloadPublicImage 2 params → 200
two-factor-auth-config-controller 9
PUT
/api/2fa/account/config
Update 2FA account config (updateTwoFaAccountConfig)
updateTwoFaAccountConfig 1 param body → 200
POST
/api/2fa/account/config
Verify and save 2FA account config (verifyAndSaveTwoFaAccountConfig)
verifyAndSaveTwoFaAccountConfig 1 param body → 200
DELETE
/api/2fa/account/config
Delete 2FA account config (deleteTwoFaAccountConfig)
deleteTwoFaAccountConfig 1 param → 200
GET
/api/2fa/settings
Get platform 2FA settings (getPlatformTwoFaSettings)
getPlatformTwoFaSettings → 200
POST
/api/2fa/settings
Save platform 2FA settings (savePlatformTwoFaSettings)
savePlatformTwoFaSettings body → 200
POST
/api/2fa/account/config/submit
Submit 2FA account config (submitTwoFaAccountConfig)
submitTwoFaAccountConfig body → 200
POST
/api/2fa/account/config/generate
Generate 2FA account config (generateTwoFaAccountConfig)
generateTwoFaAccountConfig 1 param → 200
GET
/api/2fa/providers
Get available 2FA providers (getAvailableTwoFaProviders)
getAvailableTwoFaProviders_1 → 200
GET
/api/2fa/account/settings
Get account 2FA settings (getAccountTwoFaSettings)
getAccountTwoFaSettings → 200
widgets-bundle-controller 6
POST
/api/widgetsBundle
Create Or Update Widget Bundle (saveWidgetsBundle)
saveWidgetsBundle body → 200
POST
/api/widgetsBundle/{widgetsBundleId}/widgetTypes
Update widgets bundle widgets types list (updateWidgetsBundleWidgetTypes)
updateWidgetsBundleWidgetTypes 1 param body → 200
POST
/api/widgetsBundle/{widgetsBundleId}/widgetTypeFqns
Update widgets bundle widgets list from widget type FQNs list (updateWidgetsBundleWidgetFqns)
updateWidgetsBundleWidgetFqns 1 param body → 200
GET
/api/widgetsBundles
Get Widget Bundles (getWidgetsBundles)
getWidgetsBundles_1 7 params → 200
GET
/api/widgetsBundle/{widgetsBundleId}
Get Widget Bundle (getWidgetsBundleById)
getWidgetsBundleById 2 params → 200
DELETE
/api/widgetsBundle/{widgetsBundleId}
Delete widgets bundle (deleteWidgetsBundle)
deleteWidgetsBundle 1 param → 200
widget-type-controller 9
GET
/api/widgetTypedeprecated
Get Widget Type (getWidgetType)
getWidgetTypeByBundleAliasAndTypeAlias_1 4 params → 200
POST
/api/widgetType
Create Or Update Widget Type (saveWidgetType)
saveWidgetType 1 param body → 200
GET
/api/widgetTypesdeprecated
Get all Widget types for specified Bundle (getBundleWidgetTypesByBundleAlias) (Deprecated)
getBundleWidgetTypes_1_1 12 params → 200
GET
/api/widgetTypesInfosdeprecated
Get Widget Type Info objects (getBundleWidgetTypesInfosByBundleAlias) (Deprecated)
getBundleWidgetTypesInfos_1 11 params → 200
GET
/api/widgetTypesDetailsdeprecated
Get all Widget types details for specified Bundle (getBundleWidgetTypesDetailsByBundleAlias) (Deprecated)
getBundleWidgetTypesDetails_1 4 params → 200
GET
/api/widgetTypeInfo/{widgetTypeId}
Get Widget Type Info (getWidgetTypeInfoById)
getWidgetTypeInfoById 1 param → 200
GET
/api/widgetTypeFqns
Get all Widget type fqns for specified Bundle (getBundleWidgetTypeFqns)
getBundleWidgetTypeFqns 1 param → 200
GET
/api/widgetType/{widgetTypeId}
Get Widget Type Details (getWidgetTypeById)
getWidgetTypeById 2 params → 200
DELETE
/api/widgetType/{widgetTypeId}
Delete widget type (deleteWidgetType)
deleteWidgetType 1 param → 200
tenant-controller 6
POST
/api/tenant
Create Or update Tenant (saveTenant)
saveTenant body → 200
GET
/api/tenants
Get Tenants (getTenants)
getTenants 5 params → 200
GET
/api/tenantInfos
Get Tenants Info (getTenants)
getTenantInfos 5 params → 200
GET
/api/tenant/{tenantId}
Get Tenant (getTenantById)
getTenantById 1 param → 200
DELETE
/api/tenant/{tenantId}
Delete Tenant (deleteTenant)
deleteTenant 1 param → 200
GET
/api/tenant/info/{tenantId}
Get Tenant Info (getTenantInfoById)
getTenantInfoById 1 param → 200
tenant-profile-controller 8
POST
/api/tenantProfile
Create Or update Tenant Profile (saveTenantProfile)
saveTenantProfile body → 200
POST
/api/tenantProfile/{tenantProfileId}/default
Make tenant profile default (setDefaultTenantProfile)
setDefaultTenantProfile 1 param → 200
GET
/api/tenantProfiles
Get Tenant Profiles (getTenantProfiles)
getTenantProfiles_1 6 params → 200
GET
/api/tenantProfileInfos
Get Tenant Profiles Info (getTenantProfileInfos)
getTenantProfileInfos 5 params → 200
GET
/api/tenantProfileInfo/{tenantProfileId}
Get Tenant Profile Info (getTenantProfileInfoById)
getTenantProfileInfoById 1 param → 200
GET
/api/tenantProfileInfo/default
Get default Tenant Profile Info (getDefaultTenantProfileInfo)
getDefaultTenantProfileInfo → 200
GET
/api/tenantProfile/{tenantProfileId}
Get Tenant Profile (getTenantProfileById)
getTenantProfileById 1 param → 200
DELETE
/api/tenantProfile/{tenantProfileId}
Delete Tenant Profile (deleteTenantProfile)
deleteTenantProfile 1 param → 200
device-controller 25
POST
/api/tenant/{tenantId}/device/{deviceId}
Assign device to tenant (assignDeviceToTenant)
assignDeviceToTenant 2 params → 200
POST
/api/edge/{edgeId}/device/{deviceId}
Assign device to edge (assignDeviceToEdge)
assignDeviceToEdge 2 params → 200
DELETE
/api/edge/{edgeId}/device/{deviceId}
Unassign device from edge (unassignDeviceFromEdge)
unassignDeviceFromEdge 2 params → 200
GET
/api/devices
Get Devices By Ids (getDevicesByIds)
getDevicesByIds 1 param → 200
POST
/api/devices
Find related devices (findByQuery)
findByQuery_3 body → 200
POST
/api/device
Create Or Update Device (saveDevice)
saveDevice 1 param body → 200
POST
/api/device/credentials
Update device credentials (updateDeviceCredentials)
updateDeviceCredentials body → 200
POST
/api/device/bulk_import
Import the bulk of devices (processDevicesBulkImport)
processDevicesBulkImport body → 200
POST
/api/device-with-credentials
Create Device (saveDevice) with credentials
saveDeviceWithCredentials_1 body → 200
POST
/api/customer/{customerId}/device/{deviceId}
Assign device to customer (assignDeviceToCustomer)
assignDeviceToCustomer 2 params → 200
POST
/api/customer/public/device/{deviceId}
Make device publicly available (assignDeviceToPublicCustomer)
assignDeviceToPublicCustomer 1 param → 200
POST
/api/customer/device/{deviceName}/claim
Claim device (claimDevice)
claimDevice 1 param body → 200
DELETE
/api/customer/device/{deviceName}/claim
Reclaim device (reClaimDevice)
reClaimDevice 1 param → 200
GET
/api/tenant/devices
Get Tenant Device (getTenantDevice)
getTenantDevices_1 7 params → 200
GET
/api/tenant/deviceInfos
Get Tenant Device Infos (getTenantDeviceInfos)
getTenantDeviceInfos 8 params → 200
GET
/api/edge/{edgeId}/devices
Get devices assigned to edge (getEdgeDevices)
getEdgeDevices 11 params → 200
GET
/api/devices/count/{otaPackageType}/{deviceProfileId}
Count devices by device profile (countByDeviceProfileAndEmptyOtaPackage)
countByDeviceProfileAndEmptyOtaPackage 2 params → 200
GET
/api/device/{deviceId}
Get Device (getDeviceById)
getDeviceById 1 param → 200
DELETE
/api/device/{deviceId}
Delete device (deleteDevice)
deleteDevice 1 param → 200
GET
/api/device/{deviceId}/credentials
Get Device Credentials (getDeviceCredentialsByDeviceId)
getDeviceCredentialsByDeviceId 1 param → 200
GET
/api/device/typesdeprecated
Get Device Types (getDeviceTypes)
getDeviceTypes → 200
GET
/api/device/info/{deviceId}
Get Device Info (getDeviceInfoById)
getDeviceInfoById 1 param → 200
GET
/api/customer/{customerId}/devices
Get Customer Devices (getCustomerDevices)
getCustomerDevices 7 params → 200
GET
/api/customer/{customerId}/deviceInfos
Get Customer Device Infos (getCustomerDeviceInfos)
getCustomerDeviceInfos 9 params → 200
DELETE
/api/customer/device/{deviceId}
Unassign device from customer (unassignDeviceFromCustomer)
unassignDeviceFromCustomer 1 param → 200
dashboard-controller 23
GET
/api/tenant/dashboard/home/info
Get Tenant Home Dashboard Info (getTenantHomeDashboardInfo)
getTenantHomeDashboardInfo → 200
POST
/api/tenant/dashboard/home/info
Update Tenant Home Dashboard Info (getTenantHomeDashboardInfo)
setTenantHomeDashboardInfo body → 200
POST
/api/edge/{edgeId}/dashboard/{dashboardId}
Assign dashboard to edge (assignDashboardToEdge)
assignDashboardToEdge 2 params → 200
DELETE
/api/edge/{edgeId}/dashboard/{dashboardId}
Unassign dashboard from edge (unassignDashboardFromEdge)
unassignDashboardFromEdge 2 params → 200
POST
/api/dashboard
Create Or Update Dashboard (saveDashboard)
saveDashboard body → 200
POST
/api/dashboard/{dashboardId}/customers
Update the Dashboard Customers (updateDashboardCustomers)
updateDashboardCustomers 1 param body → 200
POST
/api/dashboard/{dashboardId}/customers/remove
Remove the Dashboard Customers (removeDashboardCustomers)
removeDashboardCustomers 1 param body → 200
POST
/api/dashboard/{dashboardId}/customers/add
Adds the Dashboard Customers (addDashboardCustomers)
addDashboardCustomers 1 param body → 200
POST
/api/customer/{customerId}/dashboard/{dashboardId}
Assign the Dashboard (assignDashboardToCustomer)
assignDashboardToCustomer 2 params → 200
DELETE
/api/customer/{customerId}/dashboard/{dashboardId}
Unassign the Dashboard (unassignDashboardFromCustomer)
unassignDashboardFromCustomer 2 params → 200
POST
/api/customer/public/dashboard/{dashboardId}
Assign the Dashboard to Public Customer (assignDashboardToPublicCustomer)
assignDashboardToPublicCustomer 1 param → 200
DELETE
/api/customer/public/dashboard/{dashboardId}
Unassign the Dashboard from Public Customer (unassignDashboardFromPublicCustomer)
unassignDashboardFromPublicCustomer 1 param → 200
GET
/api/tenant/{tenantId}/dashboards
Get Tenant Dashboards by System Administrator (getTenantDashboards)
getTenantDashboards 6 params → 200
GET
/api/tenant/dashboards
Get Tenant Dashboards (getTenantDashboards)
getTenantDashboards_1 6 params → 200
GET
/api/edge/{edgeId}/dashboards
Get Edge Dashboards (getEdgeDashboards)
getEdgeDashboards 6 params → 200
GET
/api/dashboard/{dashboardId}
Get Dashboard (getDashboardById)
getDashboardById 2 params → 200
DELETE
/api/dashboard/{dashboardId}
Delete the Dashboard (deleteDashboard)
deleteDashboard 1 param → 200
GET
/api/dashboard/serverTime
Get server time (getServerTime)
getServerTime → 200
GET
/api/dashboard/maxDatapointsLimit
Get max data points limit (getMaxDatapointsLimit)
getMaxDatapointsLimit → 200
GET
/api/dashboard/info/{dashboardId}
Get Dashboard Info (getDashboardInfoById)
getDashboardInfoById 1 param → 200
GET
/api/dashboard/home
Get Home Dashboard (getHomeDashboard)
getHomeDashboard → 200
GET
/api/dashboard/home/info
Get Home Dashboard Info (getHomeDashboardInfo)
getHomeDashboardInfo → 200
GET
/api/customer/{customerId}/dashboards
Get Customer Dashboards (getCustomerDashboards)
getCustomerDashboards 7 params → 200
sbr-30-data 1
POST
/api/telem
getSBR30Telem body → 200
cbrs-controller 9
POST
/api/setConfig
setConfig body → 200
POST
/api/setCert
setCert body → 200
POST
/api/registerAll
registerAll → 200
POST
/api/deregisterAll
deregisterAll → 200
GET
/api/getStats
getStats → 200
GET
/api/getState
getState → 200
GET
/api/getDevices
getDevices 2 params → 200
GET
/api/getConfig
getConfig → 200
GET
/api/getCert
getCert → 200
rule-chain-controller 22
POST
/api/ruleChains/import
Import Rule Chains
importRuleChains 1 param body → 200
POST
/api/ruleChain
Create Or Update Rule Chain (saveRuleChain)
saveRuleChain body → 200
POST
/api/ruleChain/{ruleChainId}/root
Set Root Rule Chain (setRootRuleChain)
setRootRuleChain 1 param → 200
POST
/api/ruleChain/{ruleChainId}/edgeTemplateRoot
Set Edge Template Root Rule Chain (setEdgeTemplateRootRuleChain)
setEdgeTemplateRootRuleChain 1 param → 200
POST
/api/ruleChain/{ruleChainId}/autoAssignToEdge
Set Auto Assign To Edge Rule Chain (setAutoAssignToEdgeRuleChain)
setAutoAssignToEdgeRuleChain 1 param → 200
DELETE
/api/ruleChain/{ruleChainId}/autoAssignToEdge
Unset Auto Assign To Edge Rule Chain (unsetAutoAssignToEdgeRuleChain)
unsetAutoAssignToEdgeRuleChain 1 param → 200
POST
/api/ruleChain/testScript
Test Script function
testScript 1 param body → 200
POST
/api/ruleChain/metadata
Update Rule Chain Metadata
saveRuleChainMetaData 1 param body → 200
POST
/api/ruleChain/device/default
Create Default Rule Chain
saveRuleChain_1 body → 200
POST
/api/edge/{edgeId}/ruleChain/{ruleChainId}
Assign rule chain to edge (assignRuleChainToEdge)
assignRuleChainToEdge 2 params → 200
DELETE
/api/edge/{edgeId}/ruleChain/{ruleChainId}
Unassign rule chain from edge (unassignRuleChainFromEdge)
unassignRuleChainFromEdge 2 params → 200
GET
/api/ruleNode/{ruleNodeId}/debugIn
Get latest input message (getLatestRuleNodeDebugInput)
getLatestRuleNodeDebugInput 1 param → 200
GET
/api/ruleChains
Get Rule Chains (getRuleChains)
getRuleChains 6 params → 200
GET
/api/ruleChains/export
Export Rule Chains
exportRuleChains 1 param → 200
GET
/api/ruleChain/{ruleChainId}
Get Rule Chain (getRuleChainById)
getRuleChainById 1 param → 200
DELETE
/api/ruleChain/{ruleChainId}
Delete rule chain (deleteRuleChain)
deleteRuleChain 1 param → 200
GET
/api/ruleChain/{ruleChainId}/output/labels
Get Rule Chain output labels (getRuleChainOutputLabels)
getRuleChainOutputLabels 1 param → 200
GET
/api/ruleChain/{ruleChainId}/output/labels/usage
Get output labels usage (getRuleChainOutputLabelsUsage)
getRuleChainOutputLabelsUsage 1 param → 200
GET
/api/ruleChain/{ruleChainId}/metadata
Get Rule Chain (getRuleChainById)
getRuleChainMetaData 1 param → 200
GET
/api/ruleChain/tbelEnabled
Is TBEL script executor enabled
isTbelEnabled → 200
GET
/api/ruleChain/autoAssignToEdgeRuleChains
Get Auto Assign To Edge Rule Chains (getAutoAssignToEdgeRuleChains)
getAutoAssignToEdgeRuleChains → 200
GET
/api/edge/{edgeId}/ruleChains
Get Edge Rule Chains (getEdgeRuleChains)
getEdgeRuleChains 6 params → 200
rpc-v-2-controller 5
POST
/api/rpc/twoway/{deviceId}
Send two-way RPC request
handleTwoWayDeviceRPCRequest 1 param body → 401504400200
POST
/api/rpc/oneway/{deviceId}
Send one-way RPC request
handleOneWayDeviceRPCRequest 1 param body → 200401504400
GET
/api/rpc/persistent/{rpcId}
Get persistent RPC request
getPersistedRpc 1 param → 200
DELETE
/api/rpc/persistent/{rpcId}
Delete persistent RPC
deleteRpc 1 param → 200
GET
/api/rpc/persistent/device/{deviceId}
Get persistent RPC requests
getPersistedRpcByDevice 7 params → 200
role-controller 11
GET
/api/role
Get Role Policy (getRolePolicy)
getRolePolicy → 200
POST
/api/role
Save Or update Role (saveRole)
saveRole body → 200
POST
/api/role/{roleId}/user/{userId}
Assign role to user (assignRoleToUser)
assignRoleToUser 2 params → 200
POST
/api/role/{roleId}/default
Make Role Default (setDefaultRole)
setDefaultRole 1 param → default
GET
/api/roles
Get Roles (getRoles)
getRoles 5 params → 200
GET
/api/role/{roleId}
Get Role (getRoleById)
getRoleById 1 param → 200
DELETE
/api/role/{roleId}
Delete Role (deleteRole)
deleteRole 1 param → 200
GET
/api/role/{roleId}/users
Get Role Users (getRoleUsers)
getRoleUsers 6 params → 200
GET
/api/role/{roleId}/assignable
Get Assignable Role Users (getAssignableRoleUsers)
getAssignableRoleUsers 6 params → 200
GET
/api/role/user/{userId}
Get role for user (getRoleAssignedToUser)
getRoleAssignedToUser 1 param → 200
GET
/api/role/menu
Get Menu (getMenu)
getMenu → 200
tb-resource-controller 13
GET
/api/resource
Get Resource Infos (getResources)
getResources 6 params → 200
POST
/api/resource
Create Or Update Resource (saveResource)
saveResource body → 200
GET
/api/resource/{resourceId}deprecated
Get Resource (getResourceById)
getResourceById 1 param → 200
DELETE
/api/resource/{resourceId}
Delete Resource (deleteResource)
deleteResource 1 param → 200
GET
/api/resource/{resourceId}/download
Download Resource (downloadResource)
downloadResource 1 param → 200
GET
/api/resource/tenant
Get All Resource Infos (getAllResources)
getTenantResources 5 params → 200
GET
/api/resource/pkcs12/{resourceId}/download
Download PKCS12 Resource (downloadPkcs12ResourceIfChanged)
downloadPkcs12ResourceIfChanged 2 params → 200
GET
/api/resource/lwm2m
Get LwM2M Objects (getLwm2mListObjects)
getLwm2mListObjects 3 params → 200
GET
/api/resource/lwm2m/{resourceId}/download
Download LWM2M Resource (downloadLwm2mResourceIfChanged)
downloadLwm2mResourceIfChanged 2 params → 200
GET
/api/resource/lwm2m/page
Get LwM2M Objects (getLwm2mListObjectsPage)
getLwm2mListObjectsPage 5 params → 200
GET
/api/resource/js/{resourceId}/download
Download JS Resource (downloadJsResourceIfChanged)
downloadJsResourceIfChanged 2 params → 200
GET
/api/resource/jks/{resourceId}/download
Download JKS Resource (downloadJksResourceIfChanged)
downloadJksResourceIfChanged 2 params → 200
GET
/api/resource/info/{resourceId}
Get Resource Info (getResourceInfoById)
getResourceInfoById 1 param → 200
entity-relation-controller 8
GET
/api/relations
Get List of Relations (findByFrom)
findByTo_1_1_1 6 params → 200
POST
/api/relations
Find related entities (findByQuery)
findByQuery body → 200
DELETE
/api/relations
Delete common relations (deleteCommonRelations)
deleteRelations 2 params → 200
GET
/api/relations/info
Get List of Relation Infos (findInfoByFrom)
findInfoByTo_1 5 params → 200
POST
/api/relations/info
Find related entity infos (findInfoByQuery)
findInfoByQuery body → 200
GET
/api/relation
Get Relation (getRelation)
getRelation 6 params → 200
POST
/api/relation
Create Relation (saveRelation)
saveRelation body → 200
DELETE
/api/relation
Delete Relation (deleteRelation)
deleteRelation 6 params → 200
queue-controller 5
GET
/api/queues
Get Queues (getTenantQueuesByServiceType)
getTenantQueuesByServiceType 6 params → 200
POST
/api/queues
Create Or Update Queue (saveQueue)
saveQueue 1 param body → 200
GET
/api/queues/{queueId}
Get Queue (getQueueById)
getQueueById 1 param → 200
DELETE
/api/queues/{queueId}
Delete Queue (deleteQueue)
deleteQueue 1 param → 200
GET
/api/queues/name/{queueName}
Get Queue (getQueueByName)
getQueueByName 1 param → 200
telemetry-controller 14
POST
/api/plugins/telemetry/{entityType}/{entityId}/{scope}
Save entity attributes (saveEntityAttributesV1)
saveEntityAttributesV1 3 params body → 200401500400
DELETE
/api/plugins/telemetry/{entityType}/{entityId}/{scope}
Delete entity attributes (deleteEntityAttributes)
deleteEntityAttributes 4 params → 401400500200
POST
/api/plugins/telemetry/{entityType}/{entityId}/timeseries/{scope}
Save or update time-series data (saveEntityTelemetry)
saveEntityTelemetry 3 params body → 500400401200
POST
/api/plugins/telemetry/{entityType}/{entityId}/timeseries/{scope}/{ttl}
Save or update time-series data with TTL (saveEntityTelemetryWithTTL)
saveEntityTelemetryWithTTL 4 params body → 500400401200
POST
/api/plugins/telemetry/{entityType}/{entityId}/attributes/{scope}
Save entity attributes (saveEntityAttributesV2)
saveEntityAttributesV2 3 params body → 200401500400
POST
/api/plugins/telemetry/{deviceId}/{scope}
Save device attributes (saveDeviceAttributes)
saveDeviceAttributes 2 params body → 500400401200
DELETE
/api/plugins/telemetry/{deviceId}/{scope}
Delete device attributes (deleteDeviceAttributes)
deleteDeviceAttributes 3 params → 200400401500
GET
/api/plugins/telemetry/{entityType}/{entityId}/values/timeseries
Get time-series data (getTimeseries)
getLatestTimeseries_1 12 params → 200
GET
/api/plugins/telemetry/{entityType}/{entityId}/values/attributes
Get attributes (getAttributes)
getAttributes 3 params → 200
GET
/api/plugins/telemetry/{entityType}/{entityId}/values/attributes/{scope}
Get attributes by scope (getAttributesByScope)
getAttributesByScope 4 params → 200
GET
/api/plugins/telemetry/{entityType}/{entityId}/keys/timeseries
Get time-series keys (getTimeseriesKeys)
getTimeseriesKeys 2 params → 200
GET
/api/plugins/telemetry/{entityType}/{entityId}/keys/attributes
Get all attribute keys (getAttributeKeys)
getAttributeKeys 2 params → 200
GET
/api/plugins/telemetry/{entityType}/{entityId}/keys/attributes/{scope}
Get all attribute keys by scope (getAttributeKeysByScope)
getAttributeKeysByScope 3 params → 200
DELETE
/api/plugins/telemetry/{entityType}/{entityId}/timeseries/delete
Delete entity time-series data (deleteEntityTimeseries)
deleteEntityTimeseries 8 params → 401200400500
rpc-v-1-controller 2
POST
/api/plugins/rpc/twoway/{deviceId}
Send two-way RPC request (handleTwoWayDeviceRPCRequest)
handleTwoWayDeviceRPCRequest_1 1 param body → 200
POST
/api/plugins/rpc/oneway/{deviceId}
Send one-way RPC request (handleOneWayDeviceRPCRequest)
handleOneWayDeviceRPCRequest_1 1 param body → 200
ota-package-controller 9
POST
/api/otaPackage
Create Or Update OTA Package Info (saveOtaPackageInfo)
saveOtaPackageInfo body → 200
GET
/api/otaPackage/{otaPackageId}
Get OTA Package (getOtaPackageById)
getOtaPackageById 1 param → 200
POST
/api/otaPackage/{otaPackageId}
Save OTA Package data (saveOtaPackageData)
saveOtaPackageData 3 params body → 200
DELETE
/api/otaPackage/{otaPackageId}
Delete OTA Package (deleteOtaPackage)
deleteOtaPackage 1 param → 200
GET
/api/otaPackages
Get OTA Package Infos (getOtaPackages)
getOtaPackages 5 params → 200
GET
/api/otaPackages/{deviceProfileId}/{type}
Get OTA Package Infos (getOtaPackages)
getOtaPackages_1 7 params → 200
GET
/api/otaPackage/{otaPackageId}/download
Download OTA Package (downloadOtaPackage)
downloadOtaPackage 1 param → 200
GET
/api/otaPackage/info/{otaPackageId}
Get OTA Package Info (getOtaPackageInfoById)
getOtaPackageInfoById 1 param → 200
GET
/api/noauth/otaPackage/{otaPackageId}/download
downloadOtaPackageNoAuth 5 params → 200
o-auth-2-controller 4
GET
/api/oauth2/config
Get current OAuth2 settings (getCurrentOAuth2Info)
getCurrentOAuth2Info → 200
POST
/api/oauth2/config
Save OAuth2 settings (saveOAuth2Info)
saveOAuth2Info body → 200
POST
/api/noauth/oauth2Clients
Get OAuth2 clients (getOAuth2Clients)
getOAuth2Clients 2 params → 200
GET
/api/oauth2/loginProcessingUrl
Get OAuth2 log in processing URL (getLoginProcessingUrl)
getLoginProcessingUrl → 200
o-auth-2-config-template-controller 3
GET
/api/oauth2/config/template
Get the list of all OAuth2 client registration templates (getClientRegistrationTemplates) Available for users with 'SYSADMIN' or 'TENANTADMIN' authority.
getClientRegistrationTemplates → 200
POST
/api/oauth2/config/template
Create or update OAuth2 client registration template (saveClientRegistrationTemplate) Available for users with 'SYSADMIN' authority.
saveClientRegistrationTemplate body → 200
DELETE
/api/oauth2/config/template/{clientRegistrationTemplateId}
Delete OAuth2 client registration template by id (deleteClientRegistrationTemplate) Available for users with 'SYSADMIN' authority.
deleteClientRegistrationTemplate 1 param → 200
notification-template-controller 5
POST
/api/notification/template
Save notification template (saveNotificationTemplate)
saveNotificationTemplate body → 200
GET
/api/notification/templates
Get notification templates (getNotificationTemplates)
getNotificationTemplates 6 params → 200
GET
/api/notification/template/{id}
Get notification template by id (getNotificationTemplateById)
getNotificationTemplateById 1 param → 200
DELETE
/api/notification/template/{id}
Delete notification template by id (deleteNotificationTemplateById
deleteNotificationTemplateById 1 param → 200
GET
/api/notification/slack/conversations
List Slack conversations (listSlackConversations)
listSlackConversations 2 params → 200
notification-target-controller 5
POST
/api/notification/target
Save notification target (saveNotificationTarget)
saveNotificationTarget body → 200
POST
/api/notification/target/recipients
Get recipients for notification target config (getRecipientsForNotificationTargetConfig)
getRecipientsForNotificationTargetConfig 2 params body → 200
GET
/api/notification/targets
Get notification targets by ids (getNotificationTargetsByIds)
getNotificationTargets_1_1 7 params → 200
GET
/api/notification/target/{id}
Get notification target by id (getNotificationTargetById)
getNotificationTargetById 1 param → 200
DELETE
/api/notification/target/{id}
Delete notification target by id (deleteNotificationTargetById)
deleteNotificationTargetById 1 param → 200
notification-rule-controller 4
POST
/api/notification/rule
Save notification rule (saveNotificationRule)
saveNotificationRule body → 200
GET
/api/notification/rules
Get notification rules (getNotificationRules)
getNotificationRules 5 params → 200
GET
/api/notification/rule/{id}
Get notification rule by id (getNotificationRuleById)
getNotificationRuleById 1 param → 200
DELETE
/api/notification/rule/{id}
Delete notification rule (deleteNotificationRule)
deleteNotificationRule 1 param → 200
auth-controller 9
GET
/api/noauth/resetPassword
Check password reset token (checkResetToken)
checkResetToken 1 param → 200
POST
/api/noauth/resetPassword
Reset password (resetPassword)
resetPassword body → 200
POST
/api/noauth/resetPasswordByEmail
Request reset password email (requestResetPasswordByEmail)
requestResetPasswordByEmail body → 200
GET
/api/noauth/activate
Check Activate User Token (checkActivateToken)
checkActivateToken 1 param → 200
POST
/api/noauth/activate
Activate User
activateUser 1 param body → 200
POST
/api/auth/logout
Logout (logout)
logout → 200
POST
/api/auth/changePassword
Change password for current User (changePassword)
changePassword body → 200
GET
/api/noauth/userPasswordPolicy
Get the current User password policy (getUserPasswordPolicy)
getUserPasswordPolicy → 200
GET
/api/auth/user
Get current User (getUser)
getUser → 200
mobile-application-controller 7
GET
/api/mobile/app/settings
Get Mobile application settings (getMobileAppSettings)
getMobileAppSettings → 200
POST
/api/mobile/app/settings
Create Or Update the Mobile application settings (saveMobileAppSettings)
saveMobileAppSettings body → 200
GET
/api/noauth/qr
getApplicationRedirect 1 param → 200
GET
/api/noauth/qr/{secret}
Get User Token (getUserTokenByMobileSecret)
getUserTokenByMobileSecret 1 param → 200
GET
/api/mobile/deepLink
Get the deep link to the associated mobile application (getMobileAppDeepLink)
getMobileAppDeepLink → 200
GET
/.well-known/assetlinks.json
Get associated android applications (getAssetLinks)
getAssetLinks → 200
GET
/.well-known/apple-app-site-association
Get associated ios applications (getAppleAppSiteAssociation)
getAppleAppSiteAssociation → 200
lwm-2m-controller 2
POST
/api/lwm2m/device-credentials
Save device with credentials (Deprecated)
saveDeviceWithCredentials body → 200
GET
/api/lwm2m/deviceProfile/bootstrap/{isBootstrapServer}
Get Lwm2m Bootstrap SecurityInfo (getLwm2mBootstrapSecurityInfo)
getLwm2mBootstrapSecurityInfo 1 param → 200
gen-data 1
POST
/api/genTelem
getGenTelem body → 200
event-controller 4
GET
/api/events/{entityType}/{entityId}
Get Events (Deprecated)
getEvents_1 10 params → 200
POST
/api/events/{entityType}/{entityId}
Get Events by event filter (getEvents)
getEvents 10 params body → 200
POST
/api/events/{entityType}/{entityId}/clear
Clear Events (clearEvents)
clearEvents 4 params body → 200
GET
/api/events/{entityType}/{entityId}/{eventType}
Get Events by type (getEvents)
getEvents_2 11 params → 200
entity-view-controller 16
POST
/api/entityViews
Find related entity views (findByQuery)
findByQuery_1 body → 200
POST
/api/entityView
Save or update entity view (saveEntityView)
saveEntityView body → 200
POST
/api/edge/{edgeId}/entityView/{entityViewId}
Assign entity view to edge (assignEntityViewToEdge)
assignEntityViewToEdge 2 params → 200
DELETE
/api/edge/{edgeId}/entityView/{entityViewId}
Unassign entity view from edge (unassignEntityViewFromEdge)
unassignEntityViewFromEdge 2 params → 200
POST
/api/customer/{customerId}/entityView/{entityViewId}
Assign Entity View to customer (assignEntityViewToCustomer)
assignEntityViewToCustomer 2 params → 200
POST
/api/customer/public/entityView/{entityViewId}
Make entity view publicly available (assignEntityViewToPublicCustomer)
assignEntityViewToPublicCustomer 1 param → 200
GET
/api/tenant/entityViews
Get Entity View by name (getTenantEntityView)
getTenantEntityViews_1 7 params → 200
GET
/api/tenant/entityViewInfos
Get Tenant Entity Views (getTenantEntityViews)
getTenantEntityViewInfos 6 params → 200
GET
/api/entityView/{entityViewId}
Get entity view (getEntityViewById)
getEntityViewById 1 param → 200
DELETE
/api/entityView/{entityViewId}
Delete entity view (deleteEntityView)
deleteEntityView 1 param → 200
GET
/api/entityView/types
Get Entity View Types (getEntityViewTypes)
getEntityViewTypes → 200
GET
/api/entityView/info/{entityViewId}
Get Entity View info (getEntityViewInfoById)
getEntityViewInfoById 1 param → 200
GET
/api/edge/{edgeId}/entityViews
getEdgeEntityViews 9 params → 200
GET
/api/customer/{customerId}/entityViews
Get Customer Entity Views (getCustomerEntityViews)
getCustomerEntityViews 7 params → 200
GET
/api/customer/{customerId}/entityViewInfos
Get Customer Entity View info (getCustomerEntityViewInfos)
getCustomerEntityViewInfos 7 params → 200
DELETE
/api/customer/entityView/{entityViewId}
Unassign Entity View from customer (unassignEntityViewFromCustomer)
unassignEntityViewFromCustomer 1 param → 200
entity-query-controller 5
POST
/api/entitiesQuery/find
Find Entity Data by Query
findEntityDataByQuery body → 200
POST
/api/entitiesQuery/find/keys
Find Entity Keys by Query
findEntityTimeseriesAndAttributesKeysByQuery 3 params body → 200
POST
/api/entitiesQuery/count
Count Entities by Query
countEntitiesByQuery body → 200
POST
/api/alarmsQuery/find
Find Alarms by Query
findAlarmDataByQuery body → 200
POST
/api/alarmsQuery/count
Count Alarms by Query (countAlarmsByQuery)
countAlarmsByQuery body → 200
entities-version-control-controller 12
GET
/api/entities/vc/version
List all versions (listVersions)
listVersions 6 params → 200
POST
/api/entities/vc/version
Save entities version (saveEntitiesVersion)
saveEntitiesVersion body → 200
POST
/api/entities/vc/entity
Load entities version (loadEntitiesVersion)
loadEntitiesVersion body → 200
GET
/api/entities/vc/version/{requestId}/status
Get version create request status (getVersionCreateRequestStatus)
getVersionCreateRequestStatus 1 param → 200
GET
/api/entities/vc/version/{entityType}
List entity type versions (listEntityTypeVersions)
listEntityTypeVersions 7 params → 200
GET
/api/entities/vc/version/{entityType}/{externalEntityUuid}
List entity versions (listEntityVersions)
listEntityVersions 8 params → 200
GET
/api/entities/vc/info/{versionId}/{entityType}/{externalEntityUuid}
Get entity data info (getEntityDataInfo)
getEntityDataInfo 3 params → 200
GET
/api/entities/vc/entity/{versionId}
List all entities at version (listAllEntitiesAtVersion)
listAllEntitiesAtVersion 1 param → 200
GET
/api/entities/vc/entity/{requestId}/status
Get version load request status (getVersionLoadRequestStatus)
getVersionLoadRequestStatus 1 param → 200
GET
/api/entities/vc/entity/{entityType}/{versionId}
List entities at version (listEntitiesAtVersion)
listEntitiesAtVersion 2 params → 200
GET
/api/entities/vc/diff/{entityType}/{internalEntityUuid}
Compare entity data to version (compareEntityDataToVersion)
compareEntityDataToVersion 3 params → 200
GET
/api/entities/vc/branches
List branches (listBranches)
listBranches → 200
edge-controller 22
GET
/api/edges
Get Edges By Ids (getEdgesByIds)
getEdges_1 6 params → 200
POST
/api/edges
Find related edges (findByQuery)
findByQuery_2 body → 200
POST
/api/edge
Create Or Update Edge (saveEdge)
saveEdge body → 200
POST
/api/edge/{edgeId}/{ruleChainId}/root
Set root rule chain for provided edge (setEdgeRootRuleChain)
setEdgeRootRuleChain 2 params → 200
POST
/api/edge/sync/{edgeId}
Sync edge (syncEdge)
syncEdge 1 param → 200
POST
/api/edge/bulk_import
Import the bulk of edges (processEdgesBulkImport)
processEdgesBulkImport body → 200
POST
/api/customer/{customerId}/edge/{edgeId}
Assign edge to customer (assignEdgeToCustomer)
assignEdgeToCustomer 2 params → 200
POST
/api/customer/public/edge/{edgeId}
Make edge publicly available (assignEdgeToPublicCustomer)
assignEdgeToPublicCustomer 1 param → 200
GET
/api/tenant/edges
Get Tenant Edge (getTenantEdge)
getTenantEdges_1 7 params → 200
GET
/api/tenant/edgeInfos
Get Tenant Edge Infos (getTenantEdgeInfos)
getTenantEdgeInfos 6 params → 200
GET
/api/edges/enabled
Is edges support enabled (isEdgesSupportEnabled)
isEdgesSupportEnabled → 200
GET
/api/edge/{edgeId}
Get Edge (getEdgeById)
getEdgeById 1 param → 200
DELETE
/api/edge/{edgeId}
Delete edge (deleteEdge)
deleteEdge 1 param → 200
GET
/api/edge/{edgeId}/upgrade/available
Is edge upgrade enabled (isEdgeUpgradeAvailable)
isEdgeUpgradeAvailable 1 param → 200
GET
/api/edge/types
Get Edge Types (getEdgeTypes)
getEdgeTypes → 200
GET
/api/edge/missingToRelatedRuleChains/{edgeId}
Find missing rule chains (findMissingToRelatedRuleChains)
findMissingToRelatedRuleChains 1 param → 200
GET
/api/edge/instructions/upgrade/{edgeVersion}/{method}
Get Edge Upgrade Instructions (getEdgeUpgradeInstructions)
getEdgeUpgradeInstructions 2 params → 200
GET
/api/edge/instructions/install/{edgeId}/{method}
Get Edge Install Instructions (getEdgeInstallInstructions)
getEdgeInstallInstructions 2 params → 200
GET
/api/edge/info/{edgeId}
Get Edge Info (getEdgeInfoById)
getEdgeInfoById 1 param → 200
GET
/api/customer/{customerId}/edges
Get Customer Edges (getCustomerEdges)
getCustomerEdges 7 params → 200
GET
/api/customer/{customerId}/edgeInfos
Get Customer Edge Infos (getCustomerEdgeInfos)
getCustomerEdgeInfos 7 params → 200
DELETE
/api/customer/edge/{edgeId}
Unassign edge from customer (unassignEdgeFromCustomer)
unassignEdgeFromCustomer 1 param → 200
asset-controller 18
POST
/api/edge/{edgeId}/asset/{assetId}
Assign asset to edge (assignAssetToEdge)
assignAssetToEdge 2 params → 200
DELETE
/api/edge/{edgeId}/asset/{assetId}
Unassign asset from edge (unassignAssetFromEdge)
unassignAssetFromEdge 2 params → 200
POST
/api/customer/{customerId}/asset/{assetId}
Assign asset to customer (assignAssetToCustomer)
assignAssetToCustomer 2 params → 200
POST
/api/customer/public/asset/{assetId}
Make asset publicly available (assignAssetToPublicCustomer)
assignAssetToPublicCustomer 1 param → 200
GET
/api/assets
Get Assets By Ids (getAssetsByIds)
getAssetsByIds 1 param → 200
POST
/api/assets
Find related assets (findByQuery)
findByQuery_4 body → 200
POST
/api/asset
Create Or Update Asset (saveAsset)
saveAsset body → 200
POST
/api/asset/bulk_import
Import the bulk of assets (processAssetsBulkImport)
processAssetsBulkImport body → 200
GET
/api/tenant/assets
Get Tenant Asset (getTenantAsset)
getTenantAssets_1 7 params → 200
GET
/api/tenant/assetInfos
Get Tenant Asset Infos (getTenantAssetInfos)
getTenantAssetInfos 7 params → 200
GET
/api/edge/{edgeId}/assets
Get assets assigned to edge (getEdgeAssets)
getEdgeAssets 9 params → 200
GET
/api/customer/{customerId}/assets
Get Customer Assets (getCustomerAssets)
getCustomerAssets 7 params → 200
GET
/api/customer/{customerId}/assetInfos
Get Customer Asset Infos (getCustomerAssetInfos)
getCustomerAssetInfos 8 params → 200
GET
/api/asset/{assetId}
Get Asset (getAssetById)
getAssetById 1 param → 200
DELETE
/api/asset/{assetId}
Delete asset (deleteAsset)
deleteAsset 1 param → 200
GET
/api/asset/typesdeprecated
Get Asset Types (getAssetTypes)
getAssetTypes → 200
GET
/api/asset/info/{assetId}
Get Asset Info (getAssetInfoById)
getAssetInfoById 1 param → 200
DELETE
/api/customer/asset/{assetId}
Unassign asset from customer (unassignAssetFromCustomer)
unassignAssetFromCustomer 1 param → 200
device-profile-controller 11
POST
/api/deviceProfile
Create Or Update Device Profile (saveDeviceProfile)
saveDeviceProfile body → 200
POST
/api/deviceProfile/{deviceProfileId}/default
Make Device Profile Default (setDefaultDeviceProfile)
setDefaultDeviceProfile 1 param → 200
GET
/api/deviceProfiles
Get Device Profiles (getDeviceProfiles)
getDeviceProfiles 5 params → 200
GET
/api/deviceProfileInfos
Get Device Profiles for transport type (getDeviceProfileInfos)
getDeviceProfileInfos 6 params → 200
GET
/api/deviceProfileInfo/{deviceProfileId}
Get Device Profile Info (getDeviceProfileInfoById)
getDeviceProfileInfoById 1 param → 200
GET
/api/deviceProfileInfo/default
Get Default Device Profile (getDefaultDeviceProfileInfo)
getDefaultDeviceProfileInfo → 200
GET
/api/deviceProfile/{deviceProfileId}
Get Device Profile (getDeviceProfileById)
getDeviceProfileById 2 params → 200
DELETE
/api/deviceProfile/{deviceProfileId}
Delete device profile (deleteDeviceProfile)
deleteDeviceProfile 1 param → 200
GET
/api/deviceProfile/names
Get Device Profile names (getDeviceProfileNames)
getDeviceProfileNames 1 param → 200
GET
/api/deviceProfile/devices/keys/timeseries
Get time-series keys (getTimeseriesKeys)
getTimeseriesKeys_1 1 param → 200
GET
/api/deviceProfile/devices/keys/attributes
Get attribute keys (getAttributesKeys)
getAttributesKeys 1 param → 200
customer-controller 7
POST
/api/customer
Create or update Customer (saveCustomer)
saveCustomer body → 200
GET
/api/tenant/customers
Get Tenant Customer by Customer title (getTenantCustomer)
getTenantCustomer 1 param → 200
GET
/api/customers
Get Tenant Customers (getCustomers)
getCustomers 5 params → 200
GET
/api/customer/{customerId}
Get Customer (getCustomerById)
getCustomerById 1 param → 200
DELETE
/api/customer/{customerId}
Delete Customer (deleteCustomer)
deleteCustomer 1 param → 200
GET
/api/customer/{customerId}/title
Get Customer Title (getCustomerTitleById)
getCustomerTitleById 1 param → 200
GET
/api/customer/{customerId}/shortInfo
Get short Customer info (getShortCustomerInfoById)
getShortCustomerInfoById 1 param → 200
two-factor-auth-controller 3
POST
/api/auth/2fa/verification/send
Request 2FA verification code (requestTwoFaVerificationCode)
requestTwoFaVerificationCode 1 param → 200
POST
/api/auth/2fa/verification/check
Check 2FA verification code (checkTwoFaVerificationCode)
checkTwoFaVerificationCode 2 params → 200
GET
/api/auth/2fa/providers
Get available 2FA providers (getAvailableTwoFaProviders)
getAvailableTwoFaProviders → 200
asset-profile-controller 9
POST
/api/assetProfile
Create Or Update Asset Profile (saveAssetProfile)
saveAssetProfile body → 200
POST
/api/assetProfile/{assetProfileId}/default
Make Asset Profile Default (setDefaultAssetProfile)
setDefaultAssetProfile 1 param → 200
GET
/api/assetProfiles
Get Asset Profiles (getAssetProfiles)
getAssetProfiles 5 params → 200
GET
/api/assetProfileInfos
Get Asset Profile infos (getAssetProfileInfos)
getAssetProfileInfos 5 params → 200
GET
/api/assetProfileInfo/{assetProfileId}
Get Asset Profile Info (getAssetProfileInfoById)
getAssetProfileInfoById 1 param → 200
GET
/api/assetProfileInfo/default
Get Default Asset Profile (getDefaultAssetProfileInfo)
getDefaultAssetProfileInfo → 200
GET
/api/assetProfile/{assetProfileId}
Get Asset Profile (getAssetProfileById)
getAssetProfileById 2 params → 200
DELETE
/api/assetProfile/{assetProfileId}
Delete asset profile (deleteAssetProfile)
deleteAssetProfile 1 param → 200
GET
/api/assetProfile/names
Get Asset Profile names (getAssetProfileNames)
getAssetProfileNames 1 param → 200
alarm-controller 14
POST
/api/alarm
Create or Update Alarm (saveAlarm)
saveAlarm body → 200
POST
/api/alarm/{alarmId}/clear
Clear Alarm (clearAlarm)
clearAlarm 1 param → 200
POST
/api/alarm/{alarmId}/assign/{assigneeId}
Assign/Reassign Alarm (assignAlarm)
assignAlarm 2 params → 200
POST
/api/alarm/{alarmId}/ack
Acknowledge Alarm (ackAlarm)
ackAlarm 1 param → 200
GET
/api/v2/alarms
Get All Alarms (getAllAlarmsV2)
getAllAlarmsV2 11 params → 200
GET
/api/v2/alarm/{entityType}/{entityId}
Get Alarms (getAlarmsV2)
getAlarmsV2 13 params → 200
GET
/api/alarms
Get All Alarms (getAllAlarms)
getAllAlarms 11 params → 200
GET
/api/alarm/{entityType}/{entityId}
Get Alarms (getAlarms)
getAlarms 13 params → 200
GET
/api/alarm/{alarmId}
Get Alarm (getAlarmById)
getAlarmById 1 param → 200
DELETE
/api/alarm/{alarmId}
Delete Alarm (deleteAlarm)
deleteAlarm 1 param → 200
GET
/api/alarm/types
Get Alarm Types (getAlarmTypes)
getAlarmTypes 4 params → 200
GET
/api/alarm/info/{alarmId}
Get Alarm Info (getAlarmInfoById)
getAlarmInfoById 1 param → 200
GET
/api/alarm/highestSeverity/{entityType}/{entityId}
Get Highest Alarm Severity (getHighestAlarmSeverity)
getHighestAlarmSeverity 5 params → 200
DELETE
/api/alarm/{alarmId}/assign
Unassign Alarm (unassignAlarm)
unassignAlarm 1 param → 200
alarm-comment-controller 3
GET
/api/alarm/{alarmId}/comment
Get Alarm comments (getAlarmComments)
getAlarmComments 5 params → 200
POST
/api/alarm/{alarmId}/comment
Create or update Alarm Comment
saveAlarmComment 1 param body → 200
DELETE
/api/alarm/{alarmId}/comment/{commentId}
Delete Alarm comment (deleteAlarmComment)
deleteAlarmComment 2 params → 200
admin-controller 24
POST
/api/admin/settings
Get the Administration Settings object using key (getAdminSettings)
saveAdminSettings body → 200
POST
/api/admin/settings/testSms
Send test sms (sendTestMail)
sendTestSms body → 200
POST
/api/admin/settings/testMail
Send test email (sendTestMail)
sendTestMail body → 200
GET
/api/admin/securitySettings
Get the Security Settings object
getSecuritySettings → 200
POST
/api/admin/securitySettings
Update Security Settings (saveSecuritySettings)
saveSecuritySettings body → 200
GET
/api/admin/repositorySettings
Get repository settings (getRepositorySettings)
getRepositorySettings → 200
POST
/api/admin/repositorySettings
Creates or Updates the repository settings (saveRepositorySettings)
saveRepositorySettings body → 200
DELETE
/api/admin/repositorySettings
Delete repository settings (deleteRepositorySettings)
deleteRepositorySettings → 200
POST
/api/admin/repositorySettings/checkAccess
Check repository access (checkRepositoryAccess)
checkRepositoryAccess body → 200
GET
/api/admin/jwtSettings
Get the JWT Settings object (getJwtSettings)
getJwtSettings → 200
POST
/api/admin/jwtSettings
Update JWT Settings (saveJwtSettings)
saveJwtSettings body → 200
GET
/api/admin/autoCommitSettings
Get auto commit settings (getAutoCommitSettings)
getAutoCommitSettings → 200
POST
/api/admin/autoCommitSettings
Creates or Updates the auto commit settings (saveAutoCommitSettings)
saveAutoCommitSettings body → 200
DELETE
/api/admin/autoCommitSettings
Delete auto commit settings (deleteAutoCommitSettings)
deleteAutoCommitSettings → 200
GET
/api/admin/updates
Check for new Platform Releases (checkUpdates)
checkUpdates → 200
GET
/api/admin/systemInfo
Get system info (getSystemInfo)
getSystemInfo → 200
GET
/api/admin/settings/{key}
Get the Administration Settings object using key (getAdminSettings)
getAdminSettings 1 param → 200
GET
/api/admin/repositorySettings/info
getRepositorySettingsInfo → 200
GET
/api/admin/repositorySettings/exists
Check repository settings exists (repositorySettingsExists)
repositorySettingsExists → 200
GET
/api/admin/mail/oauth2/loginProcessingUrl
Get OAuth2 log in processing URL (getMailProcessingUrl)
getMailProcessingUrl → 200
GET
/api/admin/mail/oauth2/code
codeProcessingUrl 2 params → 200
GET
/api/admin/mail/oauth2/authorize
Redirect user to mail provider login page.
getAuthorizationUrl → 200
GET
/api/admin/featuresInfo
Get features info (getFeaturesInfo)
getFeaturesInfo → 200
GET
/api/admin/autoCommitSettings/exists
Check auto commit settings exists (autoCommitSettingsExists)
autoCommitSettingsExists → 200
usage-info-controller 1
GET
/api/usage
getTenantUsageInfo → 200
ui-settings-controller 1
GET
/api/uiSettings/helpBaseUrl
Get UI help base url (getHelpBaseUrl)
getHelpBaseUrl → 200
queue-stats-controller 2
GET
/api/queueStats
Get Queue Stats entities (getTenantQueueStats)
getQueueStatsByIds_1 6 params → 200
GET
/api/queueStats/{queueStatsId}
Get Queue stats entity by id (getQueueStatsById)
getQueueStatsById 1 param → 200
moxion-aemp 2
GET
/api/moxion_aemp_faults/{page}
getMoxionAEMPFaults 2 params → 200
GET
/api/moxion_aemp/{page}
getMoxionAEMP 2 params → 200
mail-config-template-controller 1
GET
/api/mail/config/template
Get the list of all OAuth2 client registration templates (getClientRegistrationTemplates) Available for users with 'SYSADMIN' or 'TENANTADMIN' authority.
getClientRegistrationTemplates_1 → 200
edge-event-controller 1
GET
/api/edge/{edgeId}/events
Get Edge Events (getEdgeEvents)
getEdgeEvents 8 params → 200
device-connectivity-controller 3
GET
/api/device-connectivity/{protocol}/certificate/download
Download server certificate using file path defined in device.connectivity properties (downloadServerCertificate)
downloadServerCertificate 1 param → 200
GET
/api/device-connectivity/{deviceId}
Get commands to publish device telemetry (getDevicePublishTelemetryCommands)
getDevicePublishTelemetryCommands 1 param → 200
GET
/api/device-connectivity/gateway-launch/{deviceId}/docker-compose/download
Download generated docker-compose.yml file for gateway (downloadGatewayDockerCompose)
downloadGatewayDockerCompose 1 param → 200
sbr-30-latest 2
GET
/api/data
getSBR30Data 2 params → 200
GET
/api/data/v1_2
getSBR30DataV1_2 2 params → 200
gen-chiller-latest 2
GET
/api/data/gen
getGeneratorData 2 params → 200
GET
/api/data/chiller
getChillerData 2 params → 200
component-descriptor-controller 3
GET
/api/components
Get Component Descriptors (getComponentDescriptorsByTypes)
getComponentDescriptorsByTypes 2 params → 200
GET
/api/components/{componentType}
Get Component Descriptors (getComponentDescriptorsByType)
getComponentDescriptorsByType 2 params → 200
GET
/api/component/{componentDescriptorClazz}
Get Component Descriptor (getComponentDescriptorByClazz)
getComponentDescriptorByClazz 1 param → 200
audit-log-controller 4
GET
/api/audit/logs
Get all audit logs (getAuditLogs)
getAuditLogs 8 params → 200
GET
/api/audit/logs/user/{userId}
Get audit logs by user id (getAuditLogsByUserId)
getAuditLogsByUserId 9 params → 200
GET
/api/audit/logs/entity/{entityType}/{entityId}
Get audit logs by entity id (getAuditLogsByEntityId)
getAuditLogsByEntityId 10 params → 200
GET
/api/audit/logs/customer/{customerId}
Get audit logs by customer id (getAuditLogsByCustomerId)
getAuditLogsByCustomerId 9 params → 200
thingsboard-error-response-handler 7
GET
/error
handleError → 200
PUT
/error
handleError_3 → 200
POST
/error
handleError_2 → 200
DELETE
/error
handleError_5 → 200
OPTIONS
/error
handleError_6 → 200
HEAD
/error
handleError_1 → 200
PATCH
/error
handleError_4 → 200

Schemas 425

The contract defines 425 schemas that model the data the API accepts and returns. The most detailed are AlarmData (27 properties), AlarmInfo (25 properties), UsageInfo (23 properties), Alarm (22 properties). Each schema is shown below with its type and property counts.

JsonNode
A value representing the any type (object or primitive)
LoginRequest
object
2 properties 2 required
LoginResponse
object
2 properties 2 required
ThingsboardErrorResponse
object
4 properties
ThingsboardCredentialsExpiredResponse
object
5 properties
TbResourceId
object
2 properties 2 required
TbResourceInfo
object
14 properties
TenantId
object
2 properties 2 required
ImageExportData
object
8 properties
TwoFaAccountConfigUpdateRequest
object
1 property
AccountTwoFaSettings
object
1 property
BackupCodeTwoFaAccountConfig
1 required
EmailTwoFaAccountConfig
1 required
SmsTwoFaAccountConfig
1 required
TotpTwoFaAccountConfig
1 required
TwoFaAccountConfig
object
2 properties 1 required
WidgetsBundle
object
A JSON value representing the Widget Bundle.
9 properties
WidgetsBundleId
object
2 properties 2 required
WidgetTypeDetails
object
A JSON value representing the Widget Type Details.
10 properties
WidgetTypeId
object
2 properties 2 required
CustomerId
object
2 properties 2 required
RoleId
object
2 properties 2 required
User
object
A JSON value representing the User.
12 properties 2 required
UserId
object
2 properties 2 required
MobileSessionInfo
object
1 property
Tenant
object
A JSON value representing the tenant.
15 properties 1 required
TenantProfileId
object
2 properties 2 required
DefaultTenantProfileConfiguration
ProcessingStrategy
object
5 properties
SubmitStrategy
object
2 properties
TenantProfile
object
A JSON value representing the tenant profile.
7 properties
TenantProfileConfiguration
object
1 property 1 required
TenantProfileData
object
2 properties
TenantProfileQueueConfiguration
object
9 properties
CoapDeviceTransportConfiguration
DefaultDeviceConfiguration
DefaultDeviceTransportConfiguration
Device
object
12 properties 2 required
DeviceConfiguration
object
1 property 1 required
DeviceData
object
2 properties
DeviceId
object
2 properties 2 required
DeviceProfileId
object
2 properties 2 required
DeviceTransportConfiguration
object
1 property 1 required
Lwm2mDeviceTransportConfiguration
MqttDeviceTransportConfiguration
OtaPackageId
object
2 properties 2 required
SnmpDeviceTransportConfiguration
DashboardId
object
2 properties 2 required
HomeDashboardInfo
object
A JSON object that represents home dashboard id and other parameters
2 properties
TelemRequest
object
7 properties
NodeConnectionInfo
object
3 properties 3 required
RuleChain
object
A JSON value representing the rule chain.
10 properties 2 required
RuleChainConnectionInfo
object
4 properties 4 required
RuleChainData
object
A JSON value representing the rule chains.
2 properties 2 required
RuleChainId
object
2 properties 2 required
RuleChainMetaData
object
A JSON value representing the rule chain metadata.
5 properties 5 required
RuleNode
object
12 properties
RuleNodeId
object
2 properties 2 required
RuleChainImportResult
object
4 properties
DefaultRuleChainCreateRequest
object
A JSON value representing the request.
1 property 1 required
Role
object
A JSON value representing the Role.
6 properties
TbResource
object
A JSON value representing the Resource.
16 properties
EntityRelationsQuery
object
A JSON value representing the entity relations query object.
2 properties
RelationEntityTypeFilter
object
3 properties
RelationsSearchParameters
object
6 properties
EntityId
object
2 properties 2 required
EntityRelation
object
A JSON value representing the relation.
5 properties
EntityRelationInfo
object
7 properties
Queue
object
A JSON value representing the queue.
12 properties
QueueId
object
2 properties 2 required
SaveOtaPackageInfoRequest
object
A JSON value representing the OTA Package.
17 properties
OtaPackageInfo
object
16 properties
OAuth2BasicMapperConfig
object
8 properties 1 required
OAuth2CustomMapperConfig
object
4 properties
OAuth2DomainInfo
object
2 properties 2 required
OAuth2Info
object
3 properties 1 required
OAuth2MapperConfig
object
5 properties 1 required
OAuth2MobileInfo
object
2 properties 2 required
OAuth2ParamsInfo
object
3 properties 3 required
OAuth2RegistrationInfo
object
14 properties 9 required
OAuth2ClientRegistrationTemplate
object
17 properties 1 required
OAuth2ClientRegistrationTemplateId
object
1 property 1 required
Button
object
7 properties
DeliveryMethodNotificationTemplate
object
3 properties 2 required
EmailDeliveryMethodNotificationTemplate
2 required
MicrosoftTeamsDeliveryMethodNotificationTemplate
1 required
MobileAppDeliveryMethodNotificationTemplate
2 required
NotificationTemplate
object
6 properties 3 required
NotificationTemplateConfig
object
1 property 1 required
NotificationTemplateId
object
2 properties 2 required
SlackDeliveryMethodNotificationTemplate
1 required
SmsDeliveryMethodNotificationTemplate
1 required
WebDeliveryMethodNotificationTemplate
2 required
AffectedTenantAdministratorsFilter
AffectedUserFilter
AllUsersFilter
CustomerUsersFilter
1 required
EmailListFilter
1 required
MicrosoftTeamsNotificationTargetConfig
2 required
NotificationTarget
object
5 properties 2 required
NotificationTargetConfig
object
2 properties 1 required
NotificationTargetId
object
2 properties 2 required
OriginatorEntityOwnerUsersFilter
PlatformUsersNotificationTargetConfig
1 required
SlackConversation
object
6 properties 3 required
SlackNotificationTargetConfig
1 required
SystemAdministratorsFilter
TenantAdministratorsFilter
UserListFilter
1 required
UsersFilter
object
1 property 1 required
PageDataUser
object
4 properties
MobileAppNotificationDeliveryMethodConfig
1 required
NotificationDeliveryMethodConfig
object
1 property 1 required
NotificationSettings
object
1 property 1 required
SlackNotificationDeliveryMethodConfig
1 required
NotificationPref
object
2 properties 1 required
UserNotificationSettings
object
1 property 1 required
AlarmAssignmentNotificationRuleTriggerConfig
1 required
AlarmCommentNotificationRuleTriggerConfig
AlarmNotificationRuleTriggerConfig
1 required
ApiUsageLimitNotificationRuleTriggerConfig
ClearRule
object
1 property
DeviceActivityNotificationRuleTriggerConfig
1 required
EdgeCommunicationFailureNotificationRuleTriggerConfig
EdgeConnectionNotificationRuleTriggerConfig
EntitiesLimitNotificationRuleTriggerConfig
EntityActionNotificationRuleTriggerConfig
EscalatedNotificationRuleRecipientsConfig
2 required
NewPlatformVersionNotificationRuleTriggerConfig
NotificationRule
object
10 properties 5 required
NotificationRuleConfig
object
1 property
NotificationRuleId
object
2 properties 2 required
NotificationRuleRecipientsConfig
object
1 property 1 required
NotificationRuleTriggerConfig
object
1 property
RateLimitsNotificationRuleTriggerConfig
RuleEngineComponentLifecycleEventNotificationRuleTriggerConfig
TaskProcessingFailureNotificationRuleTriggerConfig
NotificationInfo
object
3 properties 1 required
NotificationRequest
object
13 properties 1 required
NotificationRequestConfig
object
1 property
NotificationRequestId
object
2 properties 2 required
NotificationRequestStats
object
4 properties
NotificationRequestPreview
object
4 properties
ResetPasswordRequest
object
Reset password request.
2 properties
JwtPair
object
JWT Pair
3 properties
ResetPasswordEmailRequest
object
The JSON object representing the reset password email request.
1 property
OAuth2ClientInfo
object
3 properties
ActivateUserRequest
object
Activate user request.
2 properties
AndroidConfig
object
4 properties
IosConfig
object
3 properties
MobileAppSettings
object
A JSON value representing the mobile apps configuration
9 properties 4 required
MobileAppSettingsId
object
1 property 1 required
QRCodeConfig
object
5 properties
ErrorEventFilter
1 required
EventFilter
object
2 properties 1 required
LifeCycleEventFilter
1 required
RuleChainDebugEventFilter
1 required
RuleNodeDebugEventFilter
1 required
StatisticsEventFilter
1 required
EventId
object
1 property 1 required
EventInfo
object
7 properties
PageDataEventInfo
object
4 properties
EntityViewSearchQuery
object
The entity view search query JSON
3 properties
AttributesEntityView
object
3 properties 3 required
EntityView
object
A JSON object representing the entity view.
11 properties 3 required
EntityViewId
object
2 properties 2 required
TelemetryEntityView
object
2 properties 2 required
ApiUsageStateFilter
AssetSearchQueryFilter
AssetTypeFilter
BooleanFilterPredicate
ComplexFilterPredicate
DeviceSearchQueryFilter
DeviceTypeFilter
DynamicValueBoolean
object
3 properties
DynamicValueDouble
object
3 properties
DynamicValueString
object
3 properties
EdgeSearchQueryFilter
EdgeTypeFilter
EntityDataPageLink
object
5 properties
EntityDataQuery
object
A JSON value representing the entity data query. See API call notes above for more details.
5 properties
EntityDataSortOrder
object
2 properties
EntityFilter
object
1 property 1 required
EntityKey
object
2 properties
EntityListFilter
EntityNameFilter
EntityTypeFilter
EntityViewSearchQueryFilter
EntityViewTypeFilter
FilterPredicateValueBoolean
object
3 properties
FilterPredicateValueDouble
object
3 properties
FilterPredicateValueString
object
3 properties
KeyFilter
object
3 properties
KeyFilterPredicate
object
1 property 1 required
NumericFilterPredicate
RelationsQueryFilter
SingleEntityFilter
StringFilterPredicate
ComparisonTsValue
object
2 properties
EntityData
object
4 properties
PageDataEntityData
object
4 properties
TsValue
object
3 properties
EntityCountQuery
object
A JSON value representing the entity count query. See API call notes above for more details.
2 properties
ComplexVersionCreateRequest
EntityTypeVersionCreateConfig
object
6 properties
SingleEntityVersionCreateRequest
VersionCreateConfig
object
3 properties
VersionCreateRequest
object
3 properties
EntityTypeVersionLoadConfig
object
5 properties
EntityTypeVersionLoadRequest
SingleEntityVersionLoadRequest
VersionLoadConfig
object
3 properties
VersionLoadRequest
object
2 properties
EdgeSearchQuery
object
3 properties
Edge
object
A JSON value representing the edge.
11 properties 4 required
EdgeId
object
2 properties 2 required
Dashboard
object
10 properties 1 required
ShortCustomerInfo
object
4 properties
Asset
object
9 properties 1 required
AssetId
object
2 properties 2 required
AssetProfileId
object
2 properties 2 required
BulkImportRequest
object
2 properties
ColumnMapping
object
2 properties
Mapping
object
4 properties
BulkImportResultEdge
object
4 properties
DeviceSearchQuery
object
The device search query JSON
3 properties
AlarmCondition
object
2 properties
AlarmConditionFilter
object
4 properties
AlarmConditionFilterKey
object
2 properties
AlarmConditionSpec
object
1 property 1 required
AlarmRule
object
4 properties
AlarmSchedule
object
2 properties
AllowCreateNewDevicesDeviceProfileProvisionConfiguration
AnyTimeSchedule
CheckPreProvisionedDevicesDeviceProfileProvisionConfiguration
ClientAttributesQueryingSnmpCommunicationConfig
CoapDeviceProfileTransportConfiguration
CoapDeviceTypeConfiguration
object
1 property 1 required
CreateOrCheckDevicesDeviceProfileProvisionConfiguration
CustomTimeSchedule
CustomTimeScheduleItem
object
4 properties
DefaultCoapDeviceTypeConfiguration
DefaultDeviceProfileConfiguration
DefaultDeviceProfileTransportConfiguration
DeviceProfile
object
A JSON value representing the device profile.
18 properties
DeviceProfileAlarm
object
8 properties
DeviceProfileConfiguration
object
1 property 1 required
DeviceProfileData
object
4 properties
DeviceProfileProvisionConfiguration
object
2 properties 1 required
DeviceProfileTransportConfiguration
object
1 property 1 required
DisabledDeviceProfileProvisionConfiguration
DurationAlarmConditionSpec
DynamicValueInteger
object
3 properties
DynamicValueLong
object
3 properties
EfentoCoapDeviceTypeConfiguration
FilterPredicateValueInteger
object
3 properties
FilterPredicateValueLong
object
3 properties
JsonTransportPayloadConfiguration
LwM2MBootstrapServerCredential
object
1 property 1 required
LwM2mVersion
object
1 property
Lwm2mDeviceProfileTransportConfiguration
MqttDeviceProfileTransportConfiguration
NoSecLwM2MBootstrapServerCredential
ObjectAttributes
object
12 properties
OtherConfiguration
object
10 properties
PSKLwM2MBootstrapServerCredential
PowerSavingConfiguration
object
4 properties
ProtoTransportPayloadConfiguration
RPKLwM2MBootstrapServerCredential
RepeatingAlarmConditionSpec
SharedAttributesSettingSnmpCommunicationConfig
SimpleAlarmConditionSpec
SnmpCommunicationConfig
object
1 property
SnmpDeviceProfileTransportConfiguration
SnmpMapping
object
3 properties
SpecificTimeSchedule
TelemetryMappingConfiguration
object
5 properties
TelemetryQueryingSnmpCommunicationConfig
ToDeviceRpcRequestSnmpCommunicationConfig
ToServerRpcRequestSnmpCommunicationConfig
TransportPayloadTypeConfiguration
object
1 property 1 required
Version
X509CertificateChainProvisionConfiguration
X509LwM2MBootstrapServerCredential
DeviceCredentials
object
A JSON value representing the device credentials.
6 properties 3 required
DeviceCredentialsId
object
1 property 1 required
BulkImportResultDevice
object
4 properties
SaveDeviceWithCredentialsRequest
object
The JSON object with device and credentials. See method description above for example.
2 properties 2 required
Customer
object
14 properties 2 required
ClaimRequest
object
Claiming request which can optionally contain secret key
1 property
ChangePasswordRequest
object
Change Password Request
2 properties
AssetSearchQuery
object
3 properties
AssetProfile
object
A JSON value representing the asset profile.
11 properties
BulkImportResultAsset
object
4 properties
AlarmDataPageLink
object
13 properties
AlarmDataQuery
object
A JSON value representing the alarm data query. See API call notes above for more details.
6 properties
AlarmAssignee
object
4 properties
AlarmData
object
27 properties 7 required
AlarmId
object
2 properties 2 required
PageDataAlarmData
object
4 properties
AlarmCountQuery
object
A JSON value representing the alarm count query.
10 properties
Alarm
object
22 properties 7 required
AlarmComment
object
7 properties
AlarmCommentId
object
1 property 1 required
AlarmInfo
object
25 properties 7 required
AdminSettings
object
A JSON value representing the Mail Settings.
5 properties
AdminSettingsId
object
1 property 1 required
AwsSnsSmsProviderConfiguration
SmppSmsProviderConfiguration
5 required
SmsProviderConfiguration
object
1 property 1 required
TestSmsRequest
object
A JSON value representing the Test SMS request.
3 properties
TwilioSmsProviderConfiguration
SecuritySettings
object
A JSON value representing the Security Settings.
4 properties
UserPasswordPolicy
object
10 properties
RepositorySettings
object
A JSON value representing the Repository Settings.
10 properties
JwtSettings
object
A JSON value representing the JWT Settings.
4 properties
AutoCommitSettings
object
AutoVersionCreateConfig
object
4 properties
BackupCodeTwoFaProviderConfig
EmailTwoFaProviderConfig
PlatformTwoFaSettings
object
Settings value
5 properties 3 required
SmsTwoFaProviderConfig
1 required
TotpTwoFaProviderConfig
1 required
TwoFaProviderConfig
object
1 property 1 required
PageDataWidgetsBundle
object
4 properties
WidgetType
object
7 properties
PageDataWidgetTypeInfo
object
4 properties
WidgetTypeInfo
object
10 properties
PageDataAlarmInfo
object
4 properties
PageDataUserEmailInfo
object
4 properties
UserEmailInfo
object
4 properties
LastVisitedDashboardInfo
object
4 properties
StarredDashboardInfo
object
3 properties
UserDashboardsInfo
object
2 properties
UsageInfo
object
23 properties
PageDataTenant
object
4 properties
PageDataTenantProfile
object
4 properties
EntityInfo
object
2 properties
PageDataEntityInfo
object
4 properties
PageDataTenantInfo
object
4 properties
TenantInfo
object
16 properties 1 required
DashboardInfo
object
9 properties 1 required
PageDataDashboardInfo
object
4 properties
PageDataEntityView
object
4 properties
EntityViewInfo
object
13 properties 3 required
PageDataEntityViewInfo
object
4 properties
PageDataEdge
object
4 properties
EdgeInfo
object
13 properties 4 required
PageDataEdgeInfo
object
4 properties
PageDataDevice
object
4 properties
DeviceInfo
object
16 properties 2 required
PageDataDeviceInfo
object
4 properties
PageDataAsset
object
4 properties
AssetInfo
object
12 properties 1 required
PageDataAssetInfo
object
4 properties
PageDataRuleChain
object
4 properties
RuleChainOutputLabelsUsage
object
5 properties 5 required
Rpc
object
9 properties
RpcId
object
2 properties 2 required
PageDataRole
object
4 properties
PageDataTbResourceInfo
object
4 properties
LwM2mInstance
object
2 properties
LwM2mObject
object
6 properties
LwM2mResourceObserve
object
6 properties
PageDataQueue
object
4 properties
QueueStats
object
5 properties
QueueStatsId
object
2 properties 2 required
PageDataQueueStats
object
4 properties
PageDataOtaPackageInfo
object
4 properties
OtaPackage
object
17 properties
Notification
object
11 properties
NotificationId
object
2 properties 2 required
PageDataNotification
object
4 properties
PageDataNotificationTemplate
object
4 properties
PageDataNotificationTarget
object
4 properties
NotificationRuleInfo
object
12 properties 5 required
PageDataNotificationRuleInfo
object
4 properties
NotificationRequestInfo
object
15 properties 1 required
PageDataNotificationRequestInfo
object
4 properties
LwM2MServerSecurityConfigDefault
object
14 properties
EntitySubtype
object
3 properties
EntityVersion
object
4 properties
PageDataEntityVersion
object
4 properties
VersionCreationResult
object
6 properties
EntityDataInfo
object
3 properties
VersionedEntityInfo
object
1 property
EntityLoadError
object
4 properties
EntityTypeLoadResult
object
4 properties
VersionLoadResult
object
3 properties
AttributeExportData
object
7 properties
DeviceExportData
EntityDataDiff
object
2 properties
EntityExportDataObject
object
4 properties
RuleChainExportData
WidgetTypeExportData
WidgetsBundleExportData
BranchInfo
object
2 properties
EdgeEvent
object
10 properties
EdgeEventId
object
1 property 1 required
PageDataEdgeEvent
object
4 properties
EdgeInstructions
object
1 property
PageDataDeviceProfile
object
4 properties
DeviceProfileInfo
object
7 properties
PageDataDeviceProfileInfo
object
4 properties
HomeDashboard
object
11 properties 1 required
PageDataCustomer
object
4 properties
ComponentDescriptor
object
11 properties
ComponentDescriptorId
object
1 property 1 required
TwoFaProviderInfo
object
5 properties
AuditLog
object
12 properties
AuditLogId
object
1 property 1 required
PageDataAuditLog
object
4 properties
PageDataAssetProfile
object
4 properties
AssetProfileInfo
object
5 properties
PageDataAssetProfileInfo
object
4 properties
AlarmCommentInfo
object
10 properties
PageDataAlarmCommentInfo
object
4 properties
PageDataEntitySubtype
object
4 properties
UpdateMessage
object
6 properties
SystemInfo
object
2 properties
SystemInfoData
object
8 properties
RepositorySettingsInfo
object
2 properties
FeaturesInfo
object
5 properties
HasIdObject
object
1 property
TbImageDeleteResult
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

viridi-parente-vista-openapi.json Raw ↑
#Energy Management#IoT#Telemetry#Telematics#Battery
← Back to V APIs
API Details
ID
viridi-parente:viridi-vista-platform-api
Base URL
https://vista.viridiparente.com
Docs
https://viridiparente.com/products/iiot-intelligent-solution/
Provider
Viridi Parente
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=viridi-parente-viridi-vista-platform-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/viridi-parente-viridi-vista-platform-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Viridi ViSTA Platform API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.