Appearance
Collector API
Local collector API for LoRaWAN tilt monitoring.
Server
| URL | Description |
|---|---|
http://localhost:8000 | Local collector default |
Admin
Login
http
POST /admin/loginSource: api/admin/routes.py
Request body
| Field | Type | Required |
|---|---|---|
username | string | yes |
password | string | yes |
Responses
Response schema is not declared in the collector route source.
Refresh Access Token
http
POST /admin/refreshSource: api/admin/routes.py
Responses
Response schema is not declared in the collector route source.
Get Current User
http
GET /admin/meSource: api/admin/routes.py
Authentication
http
Authorization: Bearer <token>Responses
Response schema is not declared in the collector route source.
List Users
http
GET /admin/usersSource: api/admin/routes.py
Responses
Response schema is not declared in the collector route source.
Create User
http
POST /admin/usersSource: api/admin/routes.py
Request body
Schema: UserCreateRequest
Responses
Response schema is not declared in the collector route source.
Update User
http
PUT /admin/users/{user_id}Source: api/admin/routes.py
Parameters
| Name | In | Type | Required |
|---|---|---|---|
user_id | path | integer | yes |
Request body
Schema: UserUpdateRequest
Responses
Response schema is not declared in the collector route source.
Update User Password
http
PUT /admin/users/{user_id}/passwordSource: api/admin/routes.py
Parameters
| Name | In | Type | Required |
|---|---|---|---|
user_id | path | integer | yes |
Request body
Schema: UserPasswordRequest
Responses
Response schema is not declared in the collector route source.
Change Password
http
PUT /admin/change-passwordSource: api/admin/routes.py
Authentication
http
Authorization: Bearer <token>Request body
| Field | Type | Required |
|---|---|---|
old_password | string | yes |
new_password | string | yes |
Responses
Response schema is not declared in the collector route source.
Logout
http
POST /admin/logoutSource: api/admin/routes.py
Authentication
http
Authorization: Bearer <token>Responses
Response schema is not declared in the collector route source.
Ping Admin
http
GET /admin/pingSource: api/admin/routes.py
Authentication
http
Authorization: Bearer <token>Responses
Response schema is not declared in the collector route source.
Devices
Get Devices
http
GET /overviewSource: api/devices/routes.py
Authentication
http
Authorization: Bearer <token>Responses
Response schema is not declared in the collector route source.
Get Device History
http
GET /device/{eui}/historySource: api/devices/routes.py
Authentication
http
Authorization: Bearer <token>Parameters
| Name | In | Type | Required |
|---|---|---|---|
eui | path | string | yes |
from | query | integer | null | no |
to | query | integer | null | no |
Responses
Response schema is not declared in the collector route source.
Get Device Gps History
http
GET /device/{eui}/gps/historySource: api/devices/routes.py
Authentication
http
Authorization: Bearer <token>Parameters
| Name | In | Type | Required |
|---|---|---|---|
eui | path | string | yes |
from | query | integer | null | no |
to | query | integer | null | no |
Responses
Response schema is not declared in the collector route source.
Get Device Info
http
GET /device/{eui}/infoSource: api/devices/routes.py
Authentication
http
Authorization: Bearer <token>Parameters
| Name | In | Type | Required |
|---|---|---|---|
eui | path | string | yes |
Responses
Response schema is not declared in the collector route source.
Configuration
Get Device Config
http
GET /device/{eui}/configSource: api/configuration/routes.py
Parameters
| Name | In | Type | Required |
|---|---|---|---|
eui | path | string | yes |
Responses
Response schema is not declared in the collector route source.
Update Device Config
http
PUT /device/{eui}/configSource: api/configuration/routes.py
Parameters
| Name | In | Type | Required |
|---|---|---|---|
eui | path | string | yes |
Request body
Schema: object
Responses
Response schema is not declared in the collector route source.
Get Device Calibration
http
GET /device/{eui}/calibrationSource: api/configuration/routes.py
Parameters
| Name | In | Type | Required |
|---|---|---|---|
eui | path | string | yes |
Responses
Response schema is not declared in the collector route source.
Set Device Calibration
http
PUT /device/{eui}/calibrationSource: api/configuration/routes.py
Parameters
| Name | In | Type | Required |
|---|---|---|---|
eui | path | string | yes |
Request body
Schema: object
Responses
Response schema is not declared in the collector route source.
Reset Device Calibration
http
DELETE /device/{eui}/calibrationSource: api/configuration/routes.py
Parameters
| Name | In | Type | Required |
|---|---|---|---|
eui | path | string | yes |
Responses
Response schema is not declared in the collector route source.
Get Device Profile
http
GET /device/{eui}/profileSource: api/configuration/routes.py
Parameters
| Name | In | Type | Required |
|---|---|---|---|
eui | path | string | yes |
Responses
Response schema is not declared in the collector route source.
Set Device Profile
http
PUT /device/{eui}/profileSource: api/configuration/routes.py
Parameters
| Name | In | Type | Required |
|---|---|---|---|
eui | path | string | yes |
Request body
Schema: object
Responses
Response schema is not declared in the collector route source.
Get Device Manual Gps
http
GET /device/{eui}/manual-gpsSource: api/configuration/routes.py
Parameters
| Name | In | Type | Required |
|---|---|---|---|
eui | path | string | yes |
Responses
Response schema is not declared in the collector route source.
Set Device Manual Gps
http
PUT /device/{eui}/manual-gpsSource: api/configuration/routes.py
Parameters
| Name | In | Type | Required |
|---|---|---|---|
eui | path | string | yes |
Request body
Schema: object
Responses
Response schema is not declared in the collector route source.
Reset Device Manual Gps
http
DELETE /device/{eui}/manual-gpsSource: api/configuration/routes.py
Parameters
| Name | In | Type | Required |
|---|---|---|---|
eui | path | string | yes |
Responses
Response schema is not declared in the collector route source.
Get Logs
http
GET /logsSource: api/configuration/routes.py
Parameters
| Name | In | Type | Required |
|---|---|---|---|
start | query | integer | null | no |
end | query | integer | null | no |
topic | query | string | null | no |
page | query | integer | yes |
page_size | query | integer | yes |
Responses
Response schema is not declared in the collector route source.
Get Cloud Config
http
GET /configSource: api/configuration/routes.py
Parameters
| Name | In | Type | Required |
|---|---|---|---|
key | query | string | null | no |
Responses
Response schema is not declared in the collector route source.
Get Setup Status
http
GET /setup/statusSource: api/configuration/routes.py
Responses
Response schema is not declared in the collector route source.
Get Setup Config
http
GET /setup/configSource: api/configuration/routes.py
Responses
Response schema is not declared in the collector route source.
Complete Setup
http
PUT /setup/completeSource: api/configuration/routes.py
Responses
Response schema is not declared in the collector route source.
Check Setup Mqtt Connection
http
POST /setup/mqtt/checkSource: api/configuration/routes.py
Request body
Schema: object
Responses
Response schema is not declared in the collector route source.
Save Setup Mqtt Config
http
PUT /setup/mqttSource: api/configuration/routes.py
Request body
Schema: object
Responses
Response schema is not declared in the collector route source.
Save Setup Mqtt Server
http
PUT /setup/mqtt-serverSource: api/configuration/routes.py
Request body
Schema: object
Responses
Response schema is not declared in the collector route source.
Test Cloud Sync Connection
http
POST /config/cloud-sync/testSource: api/configuration/routes.py
Request body
Schema: object
Responses
Response schema is not declared in the collector route source.
Set Cloud Config
http
PUT /configSource: api/configuration/routes.py
Request body
Schema: object
Responses
Response schema is not declared in the collector route source.
Test Mqtt Connection
http
POST /config/mqtt/testSource: api/configuration/routes.py
Request body
Schema: object
Responses
Response schema is not declared in the collector route source.
Commands
Trigger Gps Acquisition
http
POST /device/{eui}/action/gps-acquisitionSource: api/commands/routes.py
Parameters
| Name | In | Type | Required |
|---|---|---|---|
eui | path | string | yes |
Responses
Response schema is not declared in the collector route source.
Trigger Device Info
http
POST /device/{eui}/action/device-infoSource: api/commands/routes.py
Parameters
| Name | In | Type | Required |
|---|---|---|---|
eui | path | string | yes |
Responses
Response schema is not declared in the collector route source.
Health
Ping
http
GET /pingSource: api/health/routes.py
Responses
Response schema is not declared in the collector route source.
Version
http
GET /versionSource: api/health/routes.py
Responses
Response schema is not declared in the collector route source.