Sensor Settings

Sensor settings management

Get settings for sensor

get

https://network.ruuvi.comhttps://testnet.ruuvi.com

/sensor-settings

Returns settings for all sensors owned by the authenticated user. Optionally filter by a single sensor MAC address using the sensor query parameter.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sensorstringOptional

Filter results to a single sensor by its MAC address (e.g. C6:F1:E7:D3:DA:11).

Example: C6:F1:E7:D3:DA:11Pattern: ^[0-9A-F]{2}(:[0-9A-F]{2}){5}$

Responses

200

Sensor settings fetched successfully

application/json

401

UNAUTHORIZED - Auth token missing

application/json

403

FORBIDDEN - User does not have access to this sensor

application/json

404

NOT FOUND - Sensor does not exist, or it exists but user does not have permission to view this sensor

application/json

get

/sensor-settings

HTTPcURLJavaScriptPython

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
        }
      }
    ]
  }
}

Configure a setting for a sensor

post

https://network.ruuvi.comhttps://testnet.ruuvi.com

/sensor-settings

Creates a new setting for given sensor

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

sensorstringRequired

MAC address of the sensor (e.g. C6:F1:E7:D3:DA:11)

Pattern: ^([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$

valuestring[]Required

Array of strings Example: ["\"CuriousSetting\""]

typestring[]Required

Array of setting types (strings)

timestampinteger · int64Optional

Optional epoch timestamp for the setting. If missing, it is assumed to be the current time.

Responses

200

Setting stored or updated successfully

application/json

400

INVALID - Missing or malformed fields (sensor, value, or type missing; sensor not MAC; value not JSON array; type not array)

application/json

401

UNAUTHORIZED - Auth token missing

application/json

403

FORBIDDEN - User does not have permission to edit this sensor

application/json

404

NOT FOUND - Sensor does not exist, or it exists but user does not have permission to view this sensor

application/json

409

CONFLICT - Setting with same or newer timestamp already exists

application/json

post

/sensor-settings

HTTPcURLJavaScriptPython

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"
  }
}