diff --git a/NUKI-DEVELOPER-%7C-Nuki-Bridge-HTTP-API.md b/NUKI-DEVELOPER-%7C-Nuki-Bridge-HTTP-API.md index 7c7e8e2..81739f7 100644 --- a/NUKI-DEVELOPER-%7C-Nuki-Bridge-HTTP-API.md +++ b/NUKI-DEVELOPER-%7C-Nuki-Bridge-HTTP-API.md @@ -234,4 +234,100 @@ http://192.168.1.50:8080/configAuth?enable=0&ts=2019-03-05T01:06:53Z&rnr=4711&ha
| URL | +http://192.168.1.50:8080/list | +||
|---|---|---|---|
| Usage | +Returns a list of all paired Nuki devices | +||
| URL-Parameters | +Token | +The api token configured via the Nuki app when enabling the API | +|
| Response | +JSON array. One item of the following per Nuki device | +||
| nukiid | +ID of the Nuki device | +||
| deviceType | +Nuki device type
+
|
+ ||
| name | +Name of the Nuki device | +||
| lastKnownState | +JSON list containing the last known lock state of the Nuki device | +||
| mode | +ID of the lock mode (see Modes) | +||
| state | +ID of the lock state (see Lock States) | +||
| stateName | +Name of the lock state (see Lock States) | +||
| batteryCritical | +Flag indicating if the batteries of the Nuki device are at critical level | +||
| batteryCharging | +Flag indicating if the batteries of the Nuki device are charging at the moment | +||
| batteryChargeState | +Value representing the current charge status in % | +||
| keypadBatteryCritical | +Flag indicating if the batteries of the paired Nuki Keypad are at critical level | +||
| doorsensorState | +ID of the door sensor state | +||
| doorsensorStateName | +Name of the door sensor state | +||
| ringactionTimestamp | +Timestamp of the last ring-action | +||
| ringactionState | +Flag indicating if a ring-action is currently occuring or not (reset after 30 seconds) | +||
| timestamp | +Timestamp of the retrieval of this lock state | +||
| Errors | +HTTP 401 | +Returned if the given token is invalid or a hashed token parameter is missing. | +|