Device
All Device related endpoints
Create
Create a Device
GET /api/create-device
Auth [Identifier], Scope [User]
Params
Name | Required | Type | Default | Comment |
---|---|---|---|---|
identifier | yes | string | ||
device_name | yes | string | ||
mac_address | yes | string | ||
model_id | yes | string |
Notes:
mac_address
The mac_address must be passed in proper Mac Address format: a1:b2:c3:d3:f4model_id
request Model list from MyWiFi Support
Success [200]
{
"status": "success",
"message": "Device has been successfully created.",
"device_id": [device_id]
}
Error [400]
{
"status": "error",
"message": {
[error_msgs]
}
}
Retrieve
Retrieve data for multiple or single Device(s)
GET /api/get-device
Auth [Identifier], Scope [User]
Params
Name | Required | Type | Default | Comment |
---|---|---|---|---|
identifier | yes | string | ||
device_ids | yes | string |
Notes:
device_ids
The device_ids is either a single device_id integer or a comma separated list of device_ids [maximum 10 devices_ids]
Success [200]
{
"status":"success",
"data":[
{
"id":"[device_id]",
"location_id":"[device_id]",
"model_id":”[device_id]",
"name":"[Device Name]",
"mac_address":"[Device Mac]",
"wan_ip":"[WAN IP Address]",
"create_date":"[Created DateTime]",
"update_date":"[Updated DateTime]",
"upgrade":"[0|1]",
"last_upgraded":"[Last Upgraded DateTime]",
"wifi_channel":"[WiFi Channel]",
"firmware_version":[Firmware Version],
"status":"[active|inactive]",
"live_status":"[online|offline|never_connected]"
}
]
}
Error [400]
{
"status": "error",
"message": {
[error_msgs]
}
}