REST API
Auth
Method | Route | Auth | Description |
---|---|---|---|
POST | /api/auth/login | Login and get new Token |
Bundles
Method | Route | Auth | Description |
---|---|---|---|
GET | /api/bundles/{bundle_id}/resources/{resource_id}/binary | user | Get Bundle Resource Binary |
POST | /api/bundles/{bundle_id}/resources | user | Add Bundle Resource |
Connectors
Method | Route | Auth | Description |
---|---|---|---|
DELETE | /api/connectors/{connector_id} | user | Delete Connector |
PUT | /api/connectors/{connector_id} | user | Set Connector |
GET | /api/connectors/{connector_id} | user | Get connector |
Customers
Method | Route | Auth | Description |
---|---|---|---|
GET | /api/customers/{customer_id}/avatar/{avatar_id?} | user | Get Customer Avatar |
Devices
Method | Route | Auth | Description |
---|---|---|---|
GET | /api/devices/{id}/products | user | Get Products that Device Owner can activate Device to |
GET | /api/devices/{identifier} | user | Get a Device |
POST | /api/devices/{device_id}/tag | user | Set Device Tag |
POST | /api/devices/{device_id}/reset | user | Factory Reset claimable device |
POST | /api/devices/{device_id}/ota/result | user | Report bundle version BLE Device is running after OTA |
POST | /api/devices/{device_id}/ota | user | Perform OTA on behalf of BLE device. |
DELETE | /api/devices/{device_id}/files/{path*} | user | Delete Device CloudFS file |
POST | /api/devices/{device_id}/files/{path*} | user | Upload a CloudFS file |
GET | /api/devices/{device_id}/files/{path*} | user | Get a CloudFS file |
GET | /api/devices/{device_id}/files | user | Index Device CloudFS files |
POST | /api/devices/{device_id}/activate | user | Activate Device to a Product |
PUT | /api/devices/{device_id} | user | Update a Device |
POST | /api/devices/provision | user | Provision a new Device |
GET | /api/devices | user | Get filtered list of devices |
Firmware
Method | Route | Auth | Description |
---|---|---|---|
GET | /api/firmware/{firmware_id}/images/{image_id}/binary | user | Get Firmware Image |
Flavors
Method | Route | Auth | Description |
---|---|---|---|
GET | /api/flavors/{flavor_id} | user | Get a Flavor |
Logs
Method | Route | Auth | Description |
---|---|---|---|
GET | /api/logs/{log_id} | user | Log |
GET | /api/logs | user | Logs |
Metrics
Method | Route | Auth | Description |
---|---|---|---|
GET | /api/metrics/locations/devices | user | Device Locations |
GET | /api/metrics/activity | user | Activity |
Platforms
Method | Route | Auth | Description |
---|---|---|---|
GET | /api/platforms/{platform_id}/avatar/{avatar_id?} | user | Get Platform Avatar |
GET | /api/platforms/{platform_id} | user | Get a Platform |
GET | /api/platforms | user | Index platforms |
Products
Method | Route | Auth | Description |
---|---|---|---|
POST | /api/products/{product_id}/state | user | Set Product State |
GET | /api/products/{product_id}/description.html | user | Return HTML formatted description of Product |
GET | /api/products/{product_id}/bundles/{tag} | user | Get Product bundle by tag |
DELETE | /api/products/{product_id}/assets/{path*} | user | Delete Product CloudFS asset |
POST | /api/products/{product_id}/assets/{path*} | user | Upload a CloudFS asset |
GET | /api/products/{product_id}/assets/{path*} | user | Get a CloudFS asset |
GET | /api/products/{product_id}/assets | user | Index Product CloudFS assets |
DELETE | /api/products/{product_id} | user | Delete product |
PUT | /api/products/{product_id} | user | Update a Product |
GET | /api/products/{product_id} | user | Get a Product |
POST | /api/products | user | Add a Product |
GET | /api/products | user | Index products |
Sdk
Method | Route | Auth | Description |
---|---|---|---|
POST | /api/sdk/tnt/encrypt | user | Encrypt TNT Application |
POST | /api/sdk/log | user | Log SDK activity |
POST | /api/sdk/encrypt | user | Encrypt TNT Application |
User
Method | Route | Auth | Description |
---|---|---|---|
DELETE | /api/user/tokens/{token_id} | user | Revoke Token |
PUT | /api/user/tokens/{token_id} | user | Update token title |
POST | /api/user/tokens | user | Add a Token |
GET | /api/user/tokens | user | User get tokens |
GET | /api/user/status | user | User status for dashboard |
GET | /api/user/init | user | Initial data for web app |
PUT | /api/user | user | Update own details |
GET | /api/user | user | User get own details |
Users
Method | Route | Auth | Description |
---|---|---|---|
GET | /api/users/{user_id}/avatar/{avatar_id?} | user | Get User Avatar |
POST | /api/users/{user_id}/avatar | user | Set User Avatar |