Fibaro System Rest API

FIBARO System
REST API Developer Documentation

Introduction Note:This documentation describes features available in Home Center
version 4.0 Beta or newer.
Conditions of use
How API works

Introduction
How Fibaro works
Welcome to the Fibaro Home Center Rest API,

Getting started
FGHC Rest API Functions FHCR API is a tool to help developers everywhere create amazing applications
using unlimited capabilities of our system. Fibaro provides a simple RESTful API
where each type of resource has a URL that you can interact with. All resources
are encoded as JSON objects.
Using this website, you will get to know what kind of functions are available, find
out how to use them and what are their responses. We hope this will help you to
truly use Fibaro as you want it, by making new apps, websites and many others,
integrating our system into something else or just playing around.
The software, trademarks documentation, and any other materials we provide to

help you develop Fibaro Home Center, including especially the interface
specifications “API” belong to Fibar Group. It may happen that working on an
app suggests an idea to you for an improvement in the API or our materials. If
you suggest any improvements to us and we adopt them, they become part of
the platform used by everyone, and belong to us.
The interface between your apps and the Home Center will evolve over time, but
we will do our best to maintain backwards compatibility and will inform you
timely before we roll out updates.
You may refer to Fibaro in plain text but you are not allowed to use Home
Center name and branding or to use Fibaro in any logo or graphics. What you
are allowed to do is to experiment and have fun.
Conditions of use
You are free to develop any kind of application you can imagine with Fibaro
system. There are just a few rules and restrictions you need to keep in mind:
You may not distribute the documentation shown in this document except by
links to the site itself or, if you use another method, these conditions of use
must be attached.
We want all your apps to work with our API to form a rich ecosystem of
interoperable applications, so it is a condition of access to our API
documentation that you do not use it to develop or distribute any systems or
devices which interpret the Fibaro API.
It may happen that working on an app suggests an idea to you for an

improvement in the API. If you suggest any improvements to us and we adopt
them, they become part of the platform used by everyone, and belong to Fibaro,
you will make no claims in this respect.
Make sure it is very clear from all you do that your app belongs to you and not
to Fibaro. Do not use any Home Center or Fibaro branding trademarks or trade
dress in any logo or graphics.
If you receive our API developer materials, you cannot claim ownership or IP
rights in any improvements of that material or in any of the APIs either with
respect to us or to other Fibaro app developers.
Please don’t make any applications that are obscene, not compliant with laws
and regulations, offensive or discriminatory or that infringe someone else’s
rights.
So, just as a reminder, before you can start having fun, you agree that by using
the API provided here to you, you accept these terms of use.
How API works

The FHCR API is your primary tool for controlling your smart home. This is a
RESTful interface over HTTP. The purpose of this web service interface is to give
every single device in your system and every controllable parameter a URL in
your local network. This means that controlling the system is achieved by simply
sending a new value to this local URL.
You can simply discover the current status of any variable by getting a response,
check it and make a change just by sending its the new value. That’s the basic
idea of a RESTful interface. All responses and new values are sent and returned
in JSON (JavaScript Object Notation) with UTF8 encoding so it’s easy to
generate or parse.
How Fibaro works
Fibaro is a wireless system, based on Z-Wave technology. Fibaro provides many

advantages when compared to similar systems. In general, radio systems create
a direct connection between the receiver and transmitter. However, the radio
signal is weakened by various obstacles located in its path (apartment walls,
furniture, etc.) and in extreme cases it fails to transfer required data. The
advantage of Fibaro System is that its devices, apart from being transmitters
and signal receivers, also duplicate signal. When a direct connection path
between the transmitter and the receiver cannot be established, the connection
may be achieved through other intermediate devices.
Fibaro is a bi-directional wireless system. This means that the signal is not only
sent to the receivers but also the receivers send the confirmation of its
reception. This operation confirms their status, which checks whether they are
active or not. Safety of the Fibaro System transmission is comparable to the
safety of transmission in data bus wired systems.
Fibaro operates in the free bandwidth for data transmission. The frequency
depends on radio regulations in individual countries. Each Fibaro network has its
own unique network identification number (home ID), which is why it is possible
to co-operate two or more independent systems in a single building without any
interference. In addition, each device gets its own ID – Node ID. Each, newly
added device gets two ID numbers – HOME ID and Node ID. Home ID is the
same for all devices within the network, while Node ID is unique for a given
node. If another controller (secondary master) is added to the network, it gets
the same HOME ID as the main controller.
Although Z-Wave is quite a new technology, it has already become recognized

and officially a binding standard, similarly to Wi-Fi. Many manufacturers in
various industries offer solutions based on Z-Wave technology, guaranteeing
their compatibility. This means that the system is open and it may be extended
in the future. Find more information at www.fibaro.com
(http://www.fibaro.com/).
Fibaro generates a dynamic network structure. After Fibaro System is switched

on, the location of its individual components is automatically updated in real-
time through status confirmation signals received from devices operating in a
“mesh” network.
Getting started
Make sure you have your Fibaro Home Center working properly. In case of
problems please go here, we will help you as soon as possible.
The fastest way to learn how to build apps which control our system is to use
the simple test web app built into the main controller. This lets you directly input
commands and send them.
First you need is to discover Home Center IP address. You can use Fibaro Finder
or just type in IP address into your web browser.
The simplest thing you can do with a FHCR API resource URL is GET it. (When
using REST API via HTTP, you “read” something by using the HTTP GET method).
Once you have the IP visit the following address in your web browser.
http://<Home Center IP address>/docs
This website contains a list of available functions grouped into the categories.
You can simply click one of theme to expand a list of associated functions and
methods with short descriptions.
Now you can select one operation by clicking it. It will show its Response Class,
model and model schema. Detailed description is available at this website under
“API” section. “Try it out” button lets you test selected operation on your
connected Fibaro Home Center controller.
To retrieve a specific resource you can also append its identifier to the end of
the URL. The example below shows retrieving a specific device using the HTTP
GET method.
http://192.168.77.80/api/devices/1771
Document organization
API functions are divided into five main categories. Each of them contains
function URL, description, available methods, response with table of variables
and example.
o General API
o Settings API
o Panels API
o Plugins API
o Other
Glossary terms
API – Application Programming Interface
REST – Representational State Transfer
URL – Uniform Resource Locator
JSON – JavaScript Object Notation
FHCR API – Fibaro Home Center Rest API
Timestamp – a way to track time as a running total of seconds. This count starts
at the Unix Epoch on January 1st, 1970 at UTC.
Message structure and response
The FHCR API consists of a set of commands that can be called over a REST web
service. The API commands fall into one of 4 categories, depending on the HTTP
method used:
Method: GET
Used for: Reading specific data from the Home Center controller.
Returns: JSON containing the requested resource.
Method: PUT
Used for: Modifying existing data on the Home Center controller.
Returns: A list containing one item per modified parameter.
Method: POST
Used for: Adding new data to the Home Center controller.

Returns: A list containing one item per created resource.
Method: DELETE
Used for: Deleting data from the Home Center controller.
Returns: A list containing one item per deleted resource.
Commands using PUT and POST methods will normally require a message body
to be attached to the request. The message body must be formatted using
JSON. More details and examples for formatting the message body can be found
in the documentation for each command.
Response codes
API may return the following HTTP response codes
HTTP Status Code Description
200 OK
400 Bad request – missing parameter
Unauthorized – authentication
401
required
Forbidden – valid request, no

403
server response
404 Not found – no content
405 Method not allowed – no content
Internal server error – unexpected

500
condition
501 Not implemented – no content
Bad gateway – invalid response

502
from the server
Service unavailable – server

503 overloaded or temporarily down for
maintenance
Gateway timeout – no timely

504
response from the server
Data types
Type Description
A whole number (not a fractional

Number number) that can be positive,
negative, or zero
String A sequence of characters
A boolean value which can take

Boolean
only the true or false values
A variable that holds multiple

Array
values of the same type
Note:
As you can see, by default a lot of data types are displayed as strings. It's
necessary to add a specified custom header to get the correct RESTful requests
data types as described in following example.
Example:
1. Typing an address like http://HC2IP/api/devices will give us an old and

incomplete data structure.
2. If our goal is to get the correct data types (eg. bool, int, etc.), we need to
install the REST Console, such as
https://chrome.google.com/webstore/detail/rest-
console/cokgbflfommojglbmbpenpphppikmonn
(https://chrome.google.com/webstore/detail/rest-
console/cokgbflfommojglbmbpenpphppikmonn) in our web browser.
3. Now you can type the address like http://HCIP/api/devices into the Request
UR field as presented on the screenshot below.
Custom Headers (/files/rest-api/restapi-1.png)
4. Then please type Fibaro Header - X-Fibaro-Version:2 into the Custom
Headers field as showed below.
Custom Headers (/files/rest-api/restapi-2.png)
5. You will see the correct data types as a response.
FGHC Rest API Functions

Settings
General settings
URL: /api/settings/info
Methods: GET, PUT
Description: Returns a list of parameters of Home Center controller, such as

serial number, soft version or default language, etc.
Response: Gets an object containing all controller’s general settings.
Name Type Description
Home Center serial

serialNumber String
number
Mac address of the

mac String
controller
Version of installed
softVersion String
software
beta Boolean Beta software status
Version of Z-wave
zwaveVersion String
software
Status of server in
serverStatus Number
seconds
Default interface
DefaultLanguage String
language
sunsetHour String Time of sunset
sunriseHour String Time of sunrise
hotelMode Boolean Hotel mode status
updateStableAvailab Availability of stable

Boolean
le update
temperatureUnit String Temperature unit
Availability of beta
updateBetaAvailable Boolean
version update
Newest version of
newestBetaVersion String
beta
batteryLowNotificatio Battery low

Boolean
n notification status
Sms notifications
smsManagement Boolean
status
Example:
"serialNumber": "HC2-000584",
"mac": "38:60:77:4e:5c:11",
"softVersion": "3.590",
"beta": false,
"zwaveVersion": "3.42",
"serverStatus": 1404743890,
"defaultLanguage": "en",
"sunsetHour": "21:08",
"sunriseHour": "04:51",
"hotelMode": false,
"updateStableAvailable": false,
"temperatureUnit": "C",
"updateBetaAvailable": true,
"newestBetaVersion": "3.591",
"batteryLowNotification": true,
"smsManagement": false
}
Backups
URL: /api/settings/backups
Methods: GET
Description: Returns a list of saved controller’s backups and their parameters

like number of devices, rooms or scenes, etc.
Response: Gets an object containing stored backups.
id Number Backup id
Timestamp in
timestamp Number
seconds
devices Number Number of devices
rooms Number Number of rooms
scenes Number Number of scenes
Backup description
description String
created by the user
Example:
{
"id": 9,
"timestamp": 1405506755,
"devices": 143,
"rooms": 5,
"scenes": 10,
"description": "alpha->3.903"
}
Location
URL: /api/settings/location
Methods: GET, PUT
Description: Returns a list of parameters related to date, time and location

configured by user in Home Center interface.
Response: Gets objects containing date, time and location settings.
houseNumber Number House number
timezone String Selected timezone
Network time
ntp Boolean
protocol status
Selected ntp server

ntpServer String
path
date: day, month,

Number Set date
year
time: hour, minute Number Set time
latitude Number Set latitude
longitude Number Set longitude
city String Selected city
Selected
temperatureUnit String
temperature unit
windUnit String Selected wind unit
timeFormat Number Time format (24/12)
dateFormat String Date format
Example:
{
"houseNumber": 3,
"timezone": "Europe/Warsaw",
"ntp": true,
"ntpServer": "",
"date":
{
"day": 16,
"month": 7,
"year": 2014
},
"time":
{
"hour": 15,
"minute": 11
},
"latitude": 52.425035319943,
"longitude": 16.9306182861328,
"city": "Poznan",
"temperatureUnit": "C",
"windUnit": "km/h",
"timeFormat": 24,
"dateFormat": "dd.mm.yy"
}
Network settings
URL: /api/settings/network
Methods: GET, PUT
Description: Returns a list of parameters related to network connection, such

as DHCP status, remote access availability or IP number.
Response: Gets an object containing network settings.
dhcp Boolean DHCP status
Home Center IP
ip String
address
mask String Subnet mask
gateway String Default gateway
dns String DNS server address
Remote access
remoteAccess Boolean
availability status
Example:
{
"dhcp": true,
"ip": "192.168.100.45",
"mask": "255.255.254.0",
"gateway": "192.168.100.1",
"dns": "192.168.100.1",
"remoteAccess": true
General
Devices
URL: /api/devices
Methods: GET, DELETE, POST, PUT
Description: Returns a list of devices, containing the main controller, all added
devices, virtual devices and plugins as well, including all their parameters,
properties and actions. Number of available data depends on the selected
device.
Response: Gets an array of objects containing all devices and their parameters.
id Number Device ID
name String Device name
roomID Number Room ID
type String Device type
baseType String Base type
enabled Boolean Device status
visible Boolean Visibility status
parentId Number Parent device ID
remoteGatewayId Number Remote gateway ID
viewXml Boolean Xml view status
Xml configuration
configXml Boolean
status
interfaces Array Available interfaces
created Number Time of creation
Time of last
modifier Number
modification
sortOrder Number Interface sort order
properties:
Z-Wave chip
zwaveCompany String
producer
Z-Wave protocol
zwaveInfo String
type and version
zwaveVersion Number Z-Wave version
Wake up time in
wakeUpTime Number
seconds
Polling time in
pollingTimeSec Number
seconds
Battery level in
batteryLevel Number
percent
Time of alarm delay

alarmDelay String
in seconds
Alarm exclusion
alarmExclude String
status
alarmTimeTimestam Alarm timestamp in

String
p seconds
Conditions of arming
armConditions String
an alarm
armConfig String Arming configuration
Arming delay in
armDelay String
seconds
armError String Error of arming
Arming timestamp in
armTimeTimestamp String
seconds
armed String Status of arming
batteryLowNotificatio Low battery

String
n notification status
Check if device is
configured String
configured
Check if device is
dead String
dead
deviceControlType String Device control type
deviceIcon String Interface device icon
ID of email
emailNotificationID String
notification
emailNotificationTyp Type of email

String
e notification
endPointId String ID of endpoint
Status of usage in
fibaroAlarm String
Fibaro Alarm
interval String Interval in seconds
Time of the last

lastBreached String
breach
liliOffCommand String Lili turn off command
liliOnCommand String Lili turn on command
log String Log status

Temperature from
logTemp String
log
Manufacturer of the
manufacturer String
device
Mark as dead if dead

markAsDead String
status
model String Model of the device
nodeId String Node ID
Template of
parametersTemplate String
paramaters
productInfo String Product version info
pushNotificationID String Push notification ID
Type of push
pushNotificationType String
notification
ID of the remote
remoteGatewayId String
gateway
Saving logs to event

saveLogs String
panel status
smsNotificationID String ID of sms notification
Type of sms
smsNotificationType String
notification
Template usage
useTemplate String
status
value String Current value
actions:
Force arming of the

forceArm Number
device
Meet device arming

meetArmConditions Number
conditions
Perform device
reconfigure Number
reconfiguration
setArmed Number Set device armed
setInterval Number Set interval
Example:
{
"id": 1898,
"name": "1897.0",
"roomID": 0,
"type": "com.fibaro.FGMS001",
"baseType": "com.fibaro.motionSensor",
"enabled": true,
"visible": true,
"parentId": 1897,
"remoteGatewayId": 0,
"viewXml": false,
"configXml": false,
"interfaces":
[
"battery",
"zwave",
"zwaveWakeup"
],
"properties":
"zwaveCompany": "Fibargroup",
"zwaveInfo": "3,3,67",
"zwaveVersion": 2.6,
"wakeUpTime": 4000,
"pollingTimeSec": 0,
"batteryLevel": 100,
"alarmDelay": "0",
"alarmExclude": "false",
"alarmTimeTimestamp": "0",
"armConditions":
{
"auto": false,
"devices":
{
"id": 1898,
"propertyName": "value",
"propertyValue": "0"
}
],
"time": 0
},
"armConfig": "0",
"armDelay": "0",
"armError": "{}",
"armTimeTimestamp": "0",
"armed": "false",
"batteryLowNotification": "true",
"configured": "true",
"dead": "false",
"deviceControlType": "0",
"deviceIcon": "90",
"emailNotificationID": "0",
"emailNotificationType": "0",
"endPointId": "0",
"fibaroAlarm": "false",
"interval": "0",
"lastBreached": "1405522313",
"liliOffCommand": "",
"liliOnCommand": "",
"log": "",
"logTemp": "",
"manufacturer": "",
"markAsDead": "true",
"model": "",
"nodeId": "97",
"parametersTemplate": "270",
"productInfo": "1,15,8,0,16,1,2,6",
"pushNotificationID": "0",
"pushNotificationType": "0",
"remoteGatewayId": "0",
"saveLogs": "true",
"smsNotificationID": "0",
"smsNotificationType": "0",
"useTemplate": "true",
"value": "false"
},
"actions":
"forceArm": 0,
"meetArmConditions": 0,
"reconfigure": 0,
"setArmed": 1,
"setInterval": 1
},
"created": 1405516322,
"modified": 1405516322,
"sortOrder": 121
Sections
URL: /api/sections
Description: Returns a list of sections, their names, sort orders, etc.
Response: Gets an object containing all sections defined in the interface.
id Number Section ID
name String Section name
{
"id": 2,
"name": "Floor",
"sortOrder": 2
}
Rooms
URL: /api/rooms
Description: Returns a list of rooms, their names, icons, sort orders, etc.
Response: Gets objects containing all rooms defined in the interface.
id Number Room ID
sectionID Number Section ID
icon String Room icon
defaultThermostat Number Main thermostat
defaultSensors:
Main temperature
temperature Number
sensor
Main humidity
humidity Number
sensor
light Number Main light sensor
Example:
"id": 1,
"name": "bathroom",
"sectionID": 1,
"icon": "room_bathroom",
"defaultSensors":
{
"temperature": 1701,
"humidity": 1777,
"light": 0
},
"defaultThermostat": 0,
"sortOrder": 1
}
Scenes
URL: /api/scenes

Description: Returns a list of all saved scenes and their parameters, such as
name, id and sort order.
Response: Gets an object containing scenes defined in the interface.
type String Type of scene
properties String Properties of scene
roomID Number Room ID
iconID Number Icon ID
enabled Boolean Scene status
autostart Boolean Autostart status
protectedByPIN Boolean PIN protection status
Ability to be
killable Boolean
interrupted
Number of running
runningInstances Number
instances
Status of being LUA

isLua Boolean
scene
liliStartCommand String Lili start command
liliStopCommand String Lili stop command
Example:
{
"id": 20,
"name": "New Scene",
"type": "",
"properties": "",
"roomID": 0,
"iconID": 5,
"enabled": true,
"autostart": false,
"protectedByPIN": false,
"killable": true,
"runningInstances": 0,
"isLua": false,
"liliStartCommand": "",
"liliStopCommand": "",
"sortOrder": 119
}
Users
URL: /api/users
Description: Returns a list of users, their names, types, rights, etc.
Response: Gets an object containing all users added to the interface.
type String Type of user
email String User’s email address
hasGPS Boolean GPS user status
Rights to edit
deviceRights Array
devices
sceneRights Array Rights to edit scenes
hotelRoom Number Hotel mode
Notifications sending
sendNotification Boolean
status
tracking Number Tracking status
usePin Boolean PIN usage status
Optional arming PIN

useOptionalArmPin Boolean
status
Sort order in the

initialWizard Boolean
interface
Example:
{
"id": 1919,
"name": "test",
"type": "user",
"email": "test@test.pl",
"hasGPS": false,
"deviceRights":
[
],
"sceneRights":
[
],
"hotelRoom": 0,
"sendNotifications": false,
"tracking": 0,
"usePin": false,
"useOptionalArmPin": false,
"initialWizard": true
}
Global variables
URL: /api/globalVariables
Description: Returns a list of global variables, their values and parameters.
Response: Gets an object containing all global variables.
name String Name of variable
value String Variable value
readOnly Boolean Read only status
isEnum Boolean Enum type status
Example:
"name": "var1",
"value": "1",
"readOnly": false,
"isEnum": false
RGB programs
URL: /api/RGBPrograms
Description: Returns a list of RGB lights programs.
Response: Gets an object containing RGB lights programs.
id Number Program ID
name String Program name
Example:
"id": 1,
"name": "Fireplace"
}
Tracking schedules
URL: /api/trackingSchedules
Description: Returns a list of weekly tracking schedules divided into four parts
of the day.
Response: Gets an object containing weekly tracking schedules.
Current weather
id Number
condition code
MondayMorningHou Monday morning

String
r start hour
MondayMorningHou Monday morning

String
rTo end hour
MondayMorningTim Monday morning

String
e time
Example:
{
"id": 2,
"MondayMorningHour": "6",
"MondayMorningHourTo": "12",
"MondayMorningTime": "0",
"MondayDayHour": "12",
"MondayDayHourTo": "18",
"MondayDayTime": "0",
"MondayEveningHour": "18",
"MondayEveningHourTo": "24",
"MondayEveningTime": "0",
"MondayNightHour": "24",
"MondayNightHourTo": "6",
"MondayNightTime": "0"
Linked devices
URL: /api/linkedDevices
Description: Returns a list of linked devices and their parameters.
Response: Gets an array of objects containing all linked devices.
id Number Link ID number
name String Linked device name
roomID Number Room ID number
type String Linked device type
deviceID Number Device ID number
Time of last
modified Number
modification
Array of linked
devices Array
devices
Linked device ID
id Number
number
innerType String Device inner type
Example:
{
"id": 3,
"name": "New Linked Devices",
"roomID": 1,
"type": "heating",
"deviceID": 1716,
"devices":
[
"id": 1854,
"innerType": ""
}
],
"created": 1405605040,
"modified": 1405605040,
"sortOrder": 111
Virtual devices
URL: /api/virtualDevices
Description: Returns a list of virtual devices, their source codes, properties and
actions.
Response: Gets an array of objects containing all virtual devices.
Virtual device ID
id Number
number
name String Virtual device name
roomID Number Room ID number
type String Type of device
Time of last
modified Number
modification
properties:
deviceIcon Number Virtual device icon
ip String IP address
port Number Port number
Virtual device current

currentIcon String
icon
mainLoop String Main loop code
saveLogs String Number of log
rows Array Array of rows
type String Type of element
elements Array Array of elements
id Number Element ID number
lua Boolean Lua usage status
Waiting for response

waitForResponse Boolean
status
caption String Showed caption
name String Name of element
empty Boolean Empty status
msg String Message text
buttonIcon Number Element icon
Status of being
favourite Boolean
favourite
Status of being main

main Boolean
element
actions:
pressButton Number Press button
setSlider Number Set slider
setProperty Number Set property
Example:
{
"id": 167,
"name": "Scene activation",

"roomID": 0,
"type": "virtual_device",
"properties":
{
"deviceIcon": 0,
"ip": "",
"port": 0,
"currentIcon": "0",
"mainLoop": "",
"saveLogs": "1",
"rows":
[
{
"type": "button",
"elements":
[
{
"id": 1,
"lua": true,
"waitForResponse": false,
"caption": "Scene activation",
"name": "Button11",
"empty": false,
"msg": "HC2 = Net.FHttp("192.168.100.45") HC2:setBasicAuthentication("admin
"buttonIcon": 0,
"favourite": false,
"main": true
}
]
},
{
"type": "button",
"elements":
[
{
"id": 2,
"lua": true,
"waitForResponse": false,
"caption": "Deactivate scene",

"name": "Button21",
"empty": false,
"msg": "HC2 = Net.FHttp("192.168.100.45") HC2:setBasicAuthentication("admin

"buttonIcon": 0,
"favourite": false,
"main": false
}
]
}
]
},
"actions":
{
"pressButton": 1,
"setSlider": 2,
"setProperty": 2
},
"created": 1405599778,
"modified": 1405599778,
"sortOrder": 117
}
iOS devices
URL: /api/iosDevices
Methods: GET
Description: Returns a list of added iOS devices and their parameters.
Response: Gets an object containing added iOS devices.
id Number iOS device ID
name String iOS device name
Unique device
udid String
identifier
Push notifications
push Boolean
status
Example:
"id": 1739,
"name": "iPod (Tom Jones)",
"udid": "2185A2FE-BBFF-4B83-8BDC-56508C0BF39B",
"push": true
}
VoIP devices
URL: /api/voip
Methods: GET, PUT
Description: Returns a list of VoIP clients associated with Home Center end
their parameters.
Response: Gets an array of objects containing configured VoIP clients.
voipDevices Array Array of voip devices
id Number VoIP client ID
sipDisplayName String SIP client name
sipUserID String SIP user ID

deviceIcon String Type of used icon
Example:
"voipDevices":
[
{
"id": 2,
"sipDisplayName": "admin",
"sipUserID": "555",
"deviceIcon": "91"
}
]
}
Icons
URL: /api/icons
Methods: GET
Description: Returns a list of icons available in the system.
Response: Gets an object containing interface icons.
id Number Icon ID number
Type of assigned
deviceType String
icon
iconSetName String Name of icon set
Example:
"id": 7,
"deviceType": "com.fibaro.binarySwitch",
"iconSetName": "alarm"
Panels
SMS notifications
URL: /api/panels/sms
Methods: GET, PUT
Description: Returns number of available sms and list of associated phone

numbers.
Response: Gets an array of objects containing predefined phone numbers

getting sms notifications.
Number of available
smsCount Number
sms
Array of added
phones Array
phones
id Number Phone ID
number String Phone number
alarm Boolean Alarm association
{
"smsCount": 0,
"phones":
[
{
"id": 3574,
"number": "4855555525255",
"alarm": false
}
]
}
Location
URL: /api/panels/location
Description: Returns a list of predefined locations and their parameters.
Response: Gets an object containing predefined locations.
id Number Location id
name String Location name
latitude Number Location latitude
longitude Number Location Longitude
Time of last
modified Number
modification
Example:
History panel
URL: /api/panels/history
Methods: GET
Description: Gets an array of objects containing actions stored in the event

panel for a specified time period
Response:
id Number Event ID
deviceID Number Device ID
timestamp Number Timestamp value
value String Parameter value
Example:
{
"id": 2,
"deviceID": 269,
"timestamp": 1409204323,
"value": "26.0"
},
{
"id": 1,
"deviceID": 268,
"timestamp": 1409204323,
"value": "23.0"
}
Notifications panel
URL: /api/panels/notifications
Description: Returns a list of notifications and their names.
Response: Gets an object containing all stored notifications.
id Number Notification ID
name String Notification name
Example:
{
"id": 1,
"name": "not1"
}
Heating panel
URL: /api/panels/heating
Description: Returns a list of heating zones and their settings, such as

temperature sets.
Response: Gets objects containing heating panel settings.
id Number Heating zone ID
name String Heating zone name
properties:
Manual mode
handTemperature Number
temperature
Manual mode
handTimestamp Number
timestamp
vacationTemperatur Holiday mode

Number
e temperature
Example:
{
"id": 1,
"name": "zone1",
"properties":
{
"handTemperature": 22,
"handTimestamp": 1405172970,
"vacationTemperature": 18
}
}
AC panel
URL: /api/panels/cooling
Description: Returns a list of cooling zones and their settings, such as

temperature sets.
Response: Gets objects containing AC panel settings.
properties:
Manual mode
handTemperature Number
temperature
Manual mode
timestamp
vacationTemperatur Holiday mode

Number
e temperature
Example:
{
"id": 2,
"name": "zone1",
"properties":
{
"handTemperature": 20,
"vacationTemperature": 24
}
}
Humidity panel
URL: /api/panels/humidity
Description: Returns a list of humidity zones and their settings, such as

humidity levels.
Response: Gets objects containing humidity panel settings.
properties:
Manual mode
handHumidity Number
humidity level
Manual mode
timestamp
Holiday mode
vacationHumidity Number
humidity level
Example:
{
"id": 1,
"name": "zone1",
"properties":
{
"handHumidity": 30,
"vacationHumidity": 50
}
}
Alarm panel
URL: /api/panels/alarm
Description: Returns a list of alarms and associated devices.
Response: Gets an object containing Alarm panel settings.

id Number Alarm ID
name String Alarm name
properties:
armDeviceID Number Arm Device ID
armStateDeviceID Number Arm State Device ID
Alarm State Device

alarmStateDeviceID Number
ID
Drenchers panel
URL: /api/panels/drenchers
Description: Returns a list of added drenchers and their parameters.
Response: Gets an array of objects containing Drenchers panel settings.
Adjusted water
adjustWater Number
percentage
rainDelay Number Rain delay in hours
Number of cycles
cycles Number
per day
drenchers Array Array of drenchers
id Number Sprinkler ID
name String Sprinkler name
mode String Active mode
dead Boolean Status of being dead
Manual time of
manualTime Number
enable
days Array ?
cycles Array ?
Time of next
nextDrenching Number
drenching
state Boolean Current status

Example:
{
"adjustWater": 0,
"rainDelay": 0,
"cycles": 1,
"drenchers":
[
{
"id": 1613,
"name": "1612.0",
"mode": "off",
"dead": "false",
"manualTime": 0,
"days":
[
],
"cycles":
[
],
"nextDrenching": 0,
"state": "true"
}
]
Favorite colors
URL: /api/panels/favoriteColors
Description: Returns a list of favorite colors presets, representing their RGBW

values.
Response: Gets an object containing user’s favorite colors.
id Number Preset ID
r Number Red color value
g Number Green color value
b Number Blue color value
w Number White color value
Example:
{
"id": 1,
"r": 125,
"g": 44,
"b": 125,
"w": 0
}
Fibaro Alarm panel
URL: /api/panels/fibaroAlarm
Methods: GET, PUT
Description: Returns Fibaro Alarm settings list, its properties, conditions, etc.
Response: Gets an array of objects containing Fibaro Alarm panel settings.
lastAlarmTime Number Time of last alarm
Array of triggered
triggerActions Array
actions
id Number Action ID
name String Action name
description String Action description
time Number Time of action
Status of being
isPredefined Boolean
predefined
Status of being
isActive Boolean
active
properties:
conditions Array Array of conditions
Type of device used

type String
in alarm
Arrau of alarm
properties Array
properties
name String Name of property
value String Device value

Example:
{
"lastAlarmTime": 0,
"triggerActions":
[
{
"id": 2,
"name": "Lights On",
"description": "Switch on selected lights or all lights in the house.",

"time": 0,
"isPredefined": true,
"isActive": false,
"properties":
{
"conditions":
[
"type": "com.fibaro.binarySwitch",
"properties":
[
{
"name": "isLight",
"value": "1"
}
]
},
"type": "com.fibaro.multilevelSwitch",
"properties":
[
"name": "isLight",
"value": "1"
}
]
}
}
Energy panel
URL: /api/panels/energy
Methods: GET
Description: Returns Energy panel data
Response: ?
Temperature panel
URL: /api/panels/temperature
Methods: GET
Description: Returns Temperature panel data
Response: ?
Events panel
URL: /api/panels/event
IP/api/panels/event?from=xxx&to=yyy
IP – Home Center IP address
xxx – start date timestamp
yyy – end date timestamp
Methods: GET
Description: Returns events history from defined time, device states, state
changes, their old and new values, etc.
Response: Gets an object containing events panel settings.
id Number Event ID
type String Event type
timestamp Number Event timestamp
deviceID Number Device ID
deviceType String Device type
Device property
propertyName String
name
oldValue Number Old device value
newValue Number New device value
Example:
"id": 8126,
"type": "DEVICE_EVENT",
"timestamp": 1404723546,
"deviceID": 1701,
"deviceType": "com.fibaro.temperatureSensor",
"propertyName": "value",
"oldValue": 28.6,
"newValue": 26.7
}
Plugins
Plugins types
URL: /api/plugins/types
Methods: GET
Description: Returns a list of plugins divided into categories and their

parameters.
Response: Gets an array of objects containing all available plugins.
Array of plugin’s
types Array
types
Number of plugin
category Number
category
plugins Array Array of plugins
type String Type of plugin
name String Name of plugin
description String Plugin description
user String Plugin creator
compatibility Array Plugin compatibility
predefined Boolean Predefinition status
version String Plugin version
url String Plugin URL
Status of being
installed Boolean
installed
Example:
{
"types":
[
{
"category": 0,
"plugins":
[
{
"type": "com.fibaro.dscAlarm",
"name": "DSC Alarm",

"description": "Add and configure Satel control panel, check states of inputs, outp
"user": "Fibar Group Sp. z o.o.",

"compatibility":
[
"iPad",
"iPhone",
"AndroidPhone",
"config"
],
"predefined": true,
"version": "1.0",
"url": "panels/external-alarm.html?type=com.fibaro.dscAlarm",
"installed": true
}
],
"installed": 6
]
}
Plugins installed
URL: /api/plugins/installed
Methods: GET
Description: Returns a list of installed plugins, their names and predefinition

status.
Response: Gets an object containing all installed plugins.
name String Name of plugin
Plugin predefinition
predefined Boolean
status
Example:
{
"name": "com.fibaro.satelAlarm",
"predefined": true
}
Other
Login status
URL: /api/loginStatus
Methods: GET, PUT
Description: Returns a list of parameters related to user’s login, such as status,

username or type of currently logged in user.
Response: Gets an object containing current login status.
status Boolean Login status
userID Number ID of logged in user
username String Username
Type of logged in
type String
user
Example:
{
"status": true,
"userID": 2,
"username": "admin",
"type": "superuser"
}
Password reminder
URL: /api/passwordForgotten
Methods: GET
Description: Returns a password to your account sending it by e-mail.
Response: Gets user’s password in case of forgetting.
Correct response:
{
"status": "OK"
Example:
IP/api/passwordForgotten?login=xxx
IP – your Home Center IP address
xxx – your login
Refresh states
URL: /api/refreshStates
Methods: GET
Description: Returns refreshment details and performed changes.
Response: Gets an object containing detailed last status refreshments.
status String Current status
last Number Last refresh
date String Status date
timestamp Number Timestamp
logs Array Detailed logs
changes Array Changes details
Example:
{
"status": "IDLE",
"last": 38,
"date": "12:58 | 21.07.2014",

"timestamp": 1405940300,
"logs":
[
],
"changes":
[
]
}
Network discovery
URL: /api/networkDiscovery/arp
Methods: PUT
Description: Find IP and MAC physical addresses for specified network
Response:
Debug scene
URL: /api/scene/ID/debugMessages
ID – scene ID
Methods: GET
Description: Returns messages displayed by scene of given ID.
Response: Gets an array of objects containing messages displayed during

scene debug.
timestamp Number Scene timestamp
type String Type of message
txt String Debugged text
Example:
{
"timestamp": 1406036436,
"type": "DEBUG",
"txt": "Helloworld!"
}
Call Action
URL: /api/devices/deviceID/action/actionName
deviceID – ID of an existing device
actionName – Name of an action
Methods: POST
Description: Trigger an action of the specified device

Response:
Weather status
URL: /api/weather
Methods: GET
Description: Returns a list of current and previous weather parameters

downloaded from weather.yahoo.com for your location.
Response: Gets an object containing weather data.
Current weather
ConditionCode String
condition code
Current humidity
Humidity String
level
PreviousConditionC Previous weather

String
ode condition code
Previous humidity
PreviousHumidity String
level
PreviousTemperatur Previous
String
e temperature
PreviousWeatherCo Previous weather

String
nditionConverted condition
PreviousWind String Previous wind speed
Temperature String Current temperature
Current weather
WeatherCondition String
condition
WeatherConditionCo Current weather

String
nverted condition
Wind String Current wind speed
saveLogs String Number of log
Selected
TemperatureUnit String
temperature unit
Example:
{
"ConditionCode": "34",
"Humidity": "45",
"PreviousConditionCode": "30",
"PreviousHumidity": "48",
"PreviousTemperature": "27",
"PreviousWeatherConditionConverted": "cloudy",
"PreviousWind": "24.14",
"Temperature": "28",
"WeatherCondition": "rain",
"WeatherConditionConverted": "clear",
"Wind": "27.36",
"saveLogs": "1",
"TemperatureUnit": "C"
Diagnostics
URL: /api/diagnostics
Methods: GET
Description: Returns a list of system parameters, such as memory usage, cpu

load, etc.
Response: Gets an array of objects containing system diagnostic data.
Percentage of free
memory Number
RAM memory
storage Array Storage array
name String Disk name
Percentage of used
used Number
space
cpuLoad Array Array of CPU load
Percentage of CPU
utilization that
user String occurred while
executing at the user
level
Percentage of CPU
utilization that
occurred while
nice String
executing at the user
level with nice
priority
Percentage of CPU
utilization that
system String occurred while
executing at the
system level
Percentage of time
that the CPU was
idle and the system
idle String
did not have an
outstanding disk I/O
request.
Example:
{
"memory": 62,
"storage":
[
{
"name": "system",
"used": 40
},
{
"name": "recovery",
"used": 22
],
"cpuLoad":
"cpu0":
{
"user": "291016",
"nice": "116",
"system": "237122",
"idle": "43946780"
}
},
{
"cpu1":
{
"user": "316296",
"nice": "324",
"system": "286170",
"idle": "45617346"
}
}
]
}

Fibaro System Rest API

Uploaded by

Copyright:

Available Formats

Fibaro System Rest API

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Fibaro System Rest API

Uploaded by

Copyright:

Available Formats

FIBARO System

REST API Developer Documentation

How API works

Welcome to the Fibaro Home Center Rest API,

The software, trademarks documentation, and any other materials we provide to

It may happen that working on an app suggests an idea to you for an

How API works

How Fibaro works

Fibaro is a wireless system, based on Z-Wave technology. Fibaro provides many

Although Z-Wave is quite a new technology, it has already become recognized

Fibaro generates a dynamic network structure. After Fibaro System is switched

http://<Home Center IP address>/docs

API – Application Programming Interface

REST – Representational State Transfer

URL – Uniform Resource Locator

JSON – JavaScript Object Notation

FHCR API – Fibaro Home Center Rest API

Message structure and response

Returns: JSON containing the requested resource.

Used for: Modifying existing data on the Home Center controller.

Returns: A list containing one item per modified parameter.

Used for: Adding new data to the Home Center controller.

Used for: Deleting data from the Home Center controller.

Returns: A list containing one item per deleted resource.

API may return the following HTTP response codes

HTTP Status Code Description

400 Bad request – missing parameter

Forbidden – valid request, no

404 Not found – no content

405 Method not allowed – no content

Internal server error – unexpected

501 Not implemented – no content

Bad gateway – invalid response

Service unavailable – server

Gateway timeout – no timely

A whole number (not a fractional

String A sequence of characters

A boolean value which can take

A variable that holds multiple

1. Typing an address like http://HC2IP/api/devices will give us an old and

FGHC Rest API Functions

Methods: GET, PUT

Description: Returns a list of parameters of Home Center controller, such as

Response: Gets an object containing all controller’s general settings.

Name Type Description

Home Center serial

Mac address of the

beta Boolean Beta software status

sunsetHour String Time of sunset

sunriseHour String Time of sunrise

hotelMode Boolean Hotel mode status

updateStableAvailab Availability of stable

temperatureUnit String Temperature unit

batteryLowNotificatio Battery low

Description: Returns a list of saved controller’s backups and their parameters

Response: Gets an object containing stored backups.

Name Type Description

devices Number Number of devices

rooms Number Number of rooms