Sensor Settings
Sensor settings management
Returns settings for all sensors owned by the authenticated user. Optionally filter by a single sensor MAC address using the sensor query parameter.
Filter results to a single sensor by its MAC address (e.g. C6:F1:E7:D3:DA:11).
C6:F1:E7:D3:DA:11Pattern: ^[0-9A-F]{2}(:[0-9A-F]{2}){5}$Sensor settings fetched successfully
UNAUTHORIZED - Auth token missing
FORBIDDEN - User does not have access to this sensor
NOT FOUND - Sensor does not exist, or it exists but user does not have permission to view this sensor
GET /sensor-settings HTTP/1.1
Host: network.ruuvi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"result": "success",
"data": {
"sensors": [
{
"owner": "[email protected]",
"sensor": "C6:F1:E7:D3:DA:11",
"name": "Greenhouse DA11",
"picture": "Greenhouse.jpg",
"public": false,
"canShare": true,
"offsetTemperature": 0,
"offsetHumidity": 0,
"offsetPressure": 0,
"customProfile": false,
"lastUpdated": 1732187742,
"subscription": {
"subscriptionName": "Business Standard",
"maxClaims": 50,
"maxShares": 80,
"maxSharesPerSensor": 10,
"maxHistoryDays": 1096,
"maxResolutionMinutes": 1,
"emailAlertAllowed": true,
"pushAlertAllowed": true,
"telegramAlertAllowed": true,
"delayedAlertAllowed": true,
"pdfExportAllowed": true,
"offlineAlertAllowed": true,
"isActive": true,
"endAt": "2026-07-24T10:35:42.000Z",
"lastUpdated": 1732187742
},
"settings": {
"description": "\"Fridge thermometer\"",
"description_lastUpdated": 1732187742,
"displayOrder": "[\"TEMPERATURE_0\", \"TEMPERATURE_1\", \"HUMIDITY_1\"]",
"displayOrder_lastUpdated": 1732187742
}
}
]
}
}Creates a new setting for given sensor
MAC address of the sensor (e.g. C6:F1:E7:D3:DA:11)
^([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$Array of strings
Example: ["\"CuriousSetting\""]
Array of setting types (strings)
Optional epoch timestamp for the setting. If missing, it is assumed to be the current time.
Setting stored or updated successfully
INVALID - Missing or malformed fields (sensor, value, or type missing; sensor not MAC; value not JSON array; type not array)
UNAUTHORIZED - Auth token missing
FORBIDDEN - User does not have permission to edit this sensor
NOT FOUND - Sensor does not exist, or it exists but user does not have permission to view this sensor
CONFLICT - Setting with same or newer timestamp already exists
POST /sensor-settings HTTP/1.1
Host: network.ruuvi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82
{
"sensor": "C6:F1:E7:D3:DA:11",
"value": [
"\"CuriousSetting\""
],
"type": "description"
}{
"result": "success",
"data": {
"action": "updated"
}
}Last updated