Skip to main content
POST
/
api
/
climate
/
getEnvironmentalGatewayShadows
Get environmental gateway shadows
curl --request POST \
  --url https://api2.rhombussystems.com/api/climate/getEnvironmentalGatewayShadows \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'
{
  "environmentalGatewayShadows": [
    {
      "activeAlertTriggers": {},
      "apMac": "<string>",
      "carbonMonoSense": {
        "adcRaw": 123,
        "adcVoltage": 123,
        "coConcentration": 123,
        "timestampSec": 123
      },
      "co2Sense": {
        "co2Ppm": 123,
        "relHumid": 123,
        "tempC": 123,
        "timestampSec": 123
      },
      "connected": true,
      "connectionTimestampMs": 123,
      "connectionUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "defaultInterface": "<string>",
      "defaultInterfaceMac": "<string>",
      "derivedValues": {
        "airQualityIndex": 123,
        "airQualityIndexPollutant": "OZONE",
        "calibrating": true,
        "deviceOrientation": "CEILING",
        "falsePositiveConfidencePercent": 123,
        "heatIndexDegF": 123,
        "heatIndexRangeWarning": "HEAT_INDEX_OK",
        "indoorAirQuality": 123,
        "malfunctioningModules": [
          "<string>"
        ],
        "smokeConfidencePercent": 123,
        "smokeThcConfidencePercent": 123,
        "smokeTobaccoConfidencePercent": 123,
        "timestampSec": 123,
        "tvoc": 123,
        "vapeConfidencePercent": 123,
        "vapeDetected": true,
        "vapeThcConfidencePercent": 123
      },
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "disconnectTimestampMs": 123,
      "externalIPAddress": "<string>",
      "firmwareUpdateInProgress": true,
      "firmwareUpdateTimeMs": 123,
      "firmwareVersion": "<string>",
      "formaSense": {
        "ch2oPpb": 123,
        "relHumid": 123,
        "tempC": 123,
        "timestampSec": 123
      },
      "hardwareUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "internalWanAddress": "<string>",
      "jumpHostUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "lanAddresses": [
        "<string>"
      ],
      "leakProbe": {
        "adcMv": 123,
        "adcRaw": 123,
        "leakDetected": true,
        "moistDetected": true,
        "present": true,
        "timestampSec": 123
      },
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "pmSense": {
        "nc0p5": 123,
        "nc10p0": 123,
        "nc1p0": 123,
        "nc2p5": 123,
        "nc4p0": 123,
        "noxIdx": 123,
        "pm10p0": 123,
        "pm1p0": 123,
        "pm2p5": 123,
        "pm4p0": 123,
        "relHumid": 123,
        "tempC": 123,
        "timestampSec": 123,
        "typPartSize": 123,
        "vocIdx": 123
      },
      "pressSense": {
        "pressure": 123,
        "tempC": 123,
        "timestampSec": 123
      },
      "prevConnected": true,
      "prevConnectedUpdateTimestampMs": 123,
      "region": "<string>",
      "secondaryLanAddresses": [
        "<string>"
      ],
      "ssid": "<string>",
      "state": {},
      "stateUpdatedTimestampMs": 123,
      "tempProbe": {
        "adcMv": 123,
        "adcRaw": 123,
        "present": true,
        "tempC": 123,
        "timestampSec": 123
      },
      "timestampMs": 123,
      "type": "BLE_TRACKER",
      "wanAddress": "<string>",
      "wifiSignalStrength": 123
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request to retrieve environmental gateway shadows.

Response

200 - application/json

OK

Response containing environmental gateway shadows.

environmentalGatewayShadows
object[] | null

List of environmental gateway shadows

error
boolean | null
errorMsg
string | null
warningMsg
string | null