Cloud API
On this page you will find all the information you need about integrating your smart home system with the Cloud API. Learn how to use your Cloud API most effectively in our handy installation and reset videos. Find answers to frequently asked questions in our FAQs or browse through our guides again in detail. Haven't found the right topics and answers yet and have more questions? Feel free to contact us at any time!
Cloud API Scopes
Cloud API Scopes
Permission to control Smart Home cameras. This includes:
- Turning off privacy mode
- Configuration of motion and sound sensors
- Rotation of the camera head (360° indoor camera)
- Turning lights on and off (Eyes outdoor camera)
- Changing brightness settings of the front light (Eyes outdoor camera)
- Changing names of events
- Marking events as favorites
- Marking events as seen or unseen
Permission to query the status of the smart plugs. This includes:
- Smart plug is switched on/off
- Operating mode (manual/timer)
- Energy consumption
- Power consumption
- Purpose of use (e.g. whether the smart plug is used as a light)
Permission to control the smart plugs. This includes:
- Turn smart plugs on/off
Permission to query data from the Smart Home controller. This includes:
- Software version
- Software update status
- MAC address
Permission to query the status of your Bosch Smart Home System and cameras. This includes:
Smart Home System:
- Query room temperature
- Query whether the alarm system is activated
- Query alarm status
- Query smoke alarm status
- Query status of smart plugs
- Query status of light controls
- Query status of shutter controls
- Query status of motion detectors
- Query status of door/window contacts
- Query data on scenarios
- Query data from the Smart Home Controller
- Query room names
- Query water alarm status
Cameras:
- Access to live streams
- Rotation of camera head (360° indoor camera)
- Access and download of all stored clips
- Query a list of all stored events
- Query the last snapshot
- Query the online status of cameras
- Query the privacy mode of the camera
- Query the status of the upper and lower light (Eyes outdoor camera)
- Notifications about current alarms
- Query whether the motion sensor is activated
- Query whether the sound sensor is activated
- Access to events triggered by motion
- Access to events triggered by sounds
Permission to query information about rooms
Permission to query the status of the motion detectors. This includes:
- When was motion last detected
- Battery status
Permission to query the status of shutter controls. This includes:
- Position of the shutter / blind
- Operating state
Permission to control the shutter controls. This includes:
- Change the position of the shutter or blind
Permission to query information about scenarios. This includes:
- Name of the scenario
- Time at which the scenario was last triggered
Permission to control scenarios
Permission to query the status of light controls. This includes:
- Light control is switched on/off
- Operating mode
- Energy consumption
- Power consumption
Permission to control the lights of Smart Home cameras. This includes:
- Turning the lights on and off (Eyes Outdoor Camera)
- Changing the brightness setting of the front light
Permission to manage saved events. This includes:
- Change names of events
- Mark events as favorite
Multiple actions:
- Mark events as unseen/seen
Permission to query data and clips from Smart Home Security cameras. This includes:
- Access and download of all stored clips
- Query a list of all stored events
- Query the last snapshot
- Query the online status of the Security cameras
- Query the privacy mode of the Security camera
- Query the camera head position (360° indoor camera)
- Query the status of the lights (Eyes outdoor camera)
Motion and sound sensors:
- Query whether the motion sensor is turned on
- Query whether the sound sensor is turned on
- Forwarding of alarms triggered by motion
- Forwarding of alarms triggered by sounds
Permission to control the smoke alarm. This includes:
- All networked smoke alarms will be muted
- The smoke alarm that detected smoke first cannot be muted via the API, but only on the physical device
Permission to query the status of the room climate. This includes:
- measured room temperature
- set room temperature
- operating mode (Manual/Timer)
Permission to query the status of the smoke alarm. This includes:
- Alarm siren is sounding or not sounding
- Alarm siren has been muted
Permission to access the streams, events and data of the security cameras. This includes:
- Access to live streams
- Rotation of the camera head (360° indoor camera)
- Access and download of all saved clips
- Query a list of all saved events
- Query the last snapshot
- Query the online status of the security cameras
- Query the privacy mode of the security camera
- Query the status of the upper and lower light (Eyes outdoor camera)
Motion and sound sensors:
- Query whether the motion sensor is turned on
- Query whether the sound sensor is turned on
- Forwarding of alarms triggered by motion
- Forwarding of alarms triggered by sounds
Permission to enable privacy mode. Privacy mode turns off the camera.
Permission to access the live streams of the cameras. This includes:
- Querying the live streams
- Rotation of the camera head of the indoor camera
Permission to control room climate. This includes:
- Set target temperature
Permission to query the status of door/window contacts. This includes:
- Door/window is closed or open
- Battery status
Consent to query data and control devices and services of the "Comfort" domain. This includes:
Room temperature:
- measured room temperature
- set room temperature
- operating mode (manual/timer)
- set target temperature
Plug-in adapter:
- plug-in adapter is switched on/off
- operating mode (manual/timer)
- energy consumption
- power consumption
- purpose of use (e.g. whether the plug-in adapter is used as a light)
- switch plug-in adapter on/off
Light controls:
- light control is switched on/off
- operating mode
- energy consumption
- power consumption
- switch light control on/off
Door/window contacts:
- query whether door/window is closed or open
- query battery status
Shutter controls:
- Query the position of the roller shutter or blind
- Query the operating status
- Change the position of the roller shutter or blind
Scenarios:
- Query data about scenarios
Rooms:
- Query the room names
Permission to turn on and configure Smart Home cameras. This includes:
- Turning off privacy mode
- Configuration of motion and sound sensors
- Turning lights on and off (Eyes Outdoor Camera)
- Changing brightness settings of the front light (Eyes Outdoor Camera)
Permission to query the status of alarm sirens. This includes:
- Alarm siren is sounding or not sounding
- Alarm siren is muted
Permission to activate the alarm system
Permission to control the alarm system. This includes:
- Turning the alarm system on and off
- Muting the alarm system
Permission to query the status of the alarm system. This includes:
- Alarm system is turned on/off
- Alarm system was last turned on/off (time)
Permission to control the light controls. This includes:
- Turn light control on/off
Permission to control your Bosch Smart Home system. This includes:
- Controlling the room temperature
- Activating the alarm system- Switching the smart plugs on and off
- Controlling the light controls
- Controlling the shutter control
- Muting the water alarm
Permission to turn on and configure Smart Home cameras. This includes:
- Turning off privacy mode
- Configuration of motion and sound sensors
- Turning lights on and off (Eyes outdoor camera)
- Changing brightness settings of the front light (Eyes outdoor camera)
Permission to query the status of your Bosch Smart Home System. This includes:
- Room temperature
- Alarm system is on/off
- Alarm status
- Smoke alarm status
- Smart plug status
- Light control status
- Shutter control status
- Motion detector status
- Door/window contact status
- Scenario data
- Smart Home Controller data
- Room names
- Water alarm status
Permission to query the status of the water alarm. This includes:
- Water alarm is sounding or not sounding
- Water alarm has been muted
Permission to mute the water alarm
Get in touch with us.
A personal and professional service is important to us. If you have any questions or need professional personal support, please do not hesitate to contact us.