REST API

Auth

MethodRouteAuthDescription
POST/api/auth/loginLogin and get new Token

Bundles

MethodRouteAuthDescription
GET/api/bundles/{bundle_id}/resources/{resource_id}/binaryuserGet Bundle Resource Binary
POST/api/bundles/{bundle_id}/resourcesuserAdd Bundle Resource

Connectors

MethodRouteAuthDescription
DELETE/api/connectors/{connector_id}userDelete Connector
PUT/api/connectors/{connector_id}userSet Connector
GET/api/connectors/{connector_id}userGet connector

Customers

MethodRouteAuthDescription
GET/api/customers/{customer_id}/avatar/{avatar_id?}userGet Customer Avatar

Devices

MethodRouteAuthDescription
GET/api/devices/{id}/productsuserGet Products that Device Owner can activate Device to
GET/api/devices/{identifier}userGet a Device
POST/api/devices/{device_id}/taguserSet Device Tag
POST/api/devices/{device_id}/resetuserFactory Reset claimable device
POST/api/devices/{device_id}/ota/resultuserReport bundle version BLE Device is running after OTA
POST/api/devices/{device_id}/otauserPerform OTA on behalf of BLE device.
DELETE/api/devices/{device_id}/files/{path*}userDelete Device CloudFS file
POST/api/devices/{device_id}/files/{path*}userUpload a CloudFS file
GET/api/devices/{device_id}/files/{path*}userGet a CloudFS file
GET/api/devices/{device_id}/filesuserIndex Device CloudFS files
POST/api/devices/{device_id}/activateuserActivate Device to a Product
PUT/api/devices/{device_id}userUpdate a Device
POST/api/devices/provisionuserProvision a new Device
GET/api/devicesuserGet filtered list of devices

Firmware

MethodRouteAuthDescription
GET/api/firmware/{firmware_id}/images/{image_id}/binaryuserGet Firmware Image

Flavors

MethodRouteAuthDescription
GET/api/flavors/{flavor_id}userGet a Flavor

Logs

MethodRouteAuthDescription
GET/api/logs/{log_id}userLog
GET/api/logsuserLogs

Metrics

MethodRouteAuthDescription
GET/api/metrics/locations/devicesuserDevice Locations
GET/api/metrics/activityuserActivity

Platforms

MethodRouteAuthDescription
GET/api/platforms/{platform_id}/avatar/{avatar_id?}userGet Platform Avatar
GET/api/platforms/{platform_id}userGet a Platform
GET/api/platformsuserIndex platforms

Products

MethodRouteAuthDescription
POST/api/products/{product_id}/stateuserSet Product State
GET/api/products/{product_id}/description.htmluserReturn HTML formatted description of Product
GET/api/products/{product_id}/bundles/{tag}userGet Product bundle by tag
DELETE/api/products/{product_id}/assets/{path*}userDelete Product CloudFS asset
POST/api/products/{product_id}/assets/{path*}userUpload a CloudFS asset
GET/api/products/{product_id}/assets/{path*}userGet a CloudFS asset
GET/api/products/{product_id}/assetsuserIndex Product CloudFS assets
DELETE/api/products/{product_id}userDelete product
PUT/api/products/{product_id}userUpdate a Product
GET/api/products/{product_id}userGet a Product
POST/api/productsuserAdd a Product
GET/api/productsuserIndex products

Sdk

MethodRouteAuthDescription
POST/api/sdk/tnt/encryptuserEncrypt TNT Application
POST/api/sdk/loguserLog SDK activity
POST/api/sdk/encryptuserEncrypt TNT Application

User

MethodRouteAuthDescription
DELETE/api/user/tokens/{token_id}userRevoke Token
PUT/api/user/tokens/{token_id}userUpdate token title
POST/api/user/tokensuserAdd a Token
GET/api/user/tokensuserUser get tokens
GET/api/user/statususerUser status for dashboard
GET/api/user/inituserInitial data for web app
PUT/api/useruserUpdate own details
GET/api/useruserUser get own details

Users

MethodRouteAuthDescription
GET/api/users/{user_id}/avatar/{avatar_id?}userGet User Avatar
POST/api/users/{user_id}/avataruserSet User Avatar