HTTP devices
The OpenAPI 3.1 document is generated beside this preview as openapi.json. Schemas document current behavior; they never validate runtime requests. The built-in server is loopback/host-guarded and has no authentication.
listDevices
List devices
listDevices description
Lists sanitized LAN and Roku Cloud Emulator devices, the active pointer and optional warnings.
listDevices contract
GET /api/devices
Responses: 200, 500; middleware can also return 403, 408 or 429.
listDevices see also
addDevice
Add a LAN device
addDevice description
Adds a LAN device. The first device becomes active unless an active pointer already exists. Duplicate IPs or IDs are rejected.
addDevice contract
POST /api/devices
Responses: 201, 400, 409, 500; middleware can also return 403, 408 or 429.
addDevice see also
addDevice body.ip
Device IP address.
addDevice body.id
Optional device ID; cloud device IDs are reserved.
addDevice body.name
Device display name.
addDevice body.tags
Device tags; duplicates are removed.
updateDevice
Update a LAN device
updateDevice description
Updates supplied fields on a LAN device. Cloud devices cannot be updated through this endpoint.
updateDevice contract
PUT /api/devices/:id
Responses: 200, 400, 404, 409, 500; middleware can also return 403, 408 or 429.
updateDevice see also
updateDevice params.id
Device ID, IP address or selector.
updateDevice body.id
Replacement device ID.
updateDevice body.ip
Replacement IP address.
updateDevice body.name
Replacement display name.
updateDevice body.tags
Replacement device tags; unlike add, the handler does not validate tag contents.
removeDevice
Remove a device
removeDevice description
Removes the selected LAN or cloud device configuration without stopping the device.
removeDevice contract
DELETE /api/devices/:id
Responses: 200, 400, 404, 500; middleware can also return 403, 408 or 429.
removeDevice see also
removeDevice params.id
Device ID, IP address or selector.
activateDevice
Activate a device
activateDevice description
Sets the active pointer to the selected LAN or cloud device.
activateDevice contract
POST /api/devices/:id/activate
Responses: 200, 400, 404, 500; middleware can also return 403, 408 or 429.
activateDevice see also
activateDevice params.id
Device ID, IP address or selector.
clearActiveDevice
Clear the active device
clearActiveDevice description
Clears the active pointer without removing device configurations.
clearActiveDevice contract
POST /api/devices/clear-active
Responses: 200, 400, 500; middleware can also return 403, 408 or 429.
clearActiveDevice see also
getActiveDeviceIp
Get the active device IP
getActiveDeviceIp description
Returns the active LAN device IP. An active cloud device without an IP returns a conflict.
getActiveDeviceIp contract
GET /api/devices/active/ip
Responses: 200, 404, 409, 500; middleware can also return 403, 408 or 429.
getActiveDeviceIp see also
getDeviceDevId
Get a device developer ID
getDeviceDevId description
Queries the keyed developer ID from device-info for the selected or active device. Cloud service failures preserve their mapped HTTP status.
getDeviceDevId contract
POST /api/devices/dev-id
Responses: 200, 400, 404, 409, 429, 500, 502, 504; middleware can also return 403, 408 or 429.
getDeviceDevId see also
getDeviceDevId body.device
Device selector; omitted selects the active device.
rebootDevice
Reboot a device
rebootDevice description
Requests a reboot through the device update service.
rebootDevice contract
POST /api/devices/reboot
Responses: 200, 400, 404, 500; middleware can also return 403, 408 or 429.
rebootDevice see also
rebootDevice body.device
Device selector; omitted selects the active device.
checkDeviceUpdate
Check for a firmware update
checkDeviceUpdate description
Requests a firmware update check through the device update service.
checkDeviceUpdate contract
POST /api/devices/check-update
Responses: 200, 400, 404, 500; middleware can also return 403, 408 or 429.
checkDeviceUpdate see also
checkDeviceUpdate body.device
Device selector; omitted selects the active device.
setDefaultDeviceAuth
Set default device authentication
setDefaultDeviceAuth description
Writes default device authentication into the private configuration. The current handler accepts any truthy password value; presence is required.
setDefaultDeviceAuth contract
PUT /api/devices/default/auth
Responses: 200, 400, 500; middleware can also return 403, 408 or 429.
setDefaultDeviceAuth see also
setDefaultDeviceAuth body.password
Default developer password; the current handler checks presence, not type.
Updated about 5 hours ago