Climate

Get environmental gateway shadows

Get list of shadows of all environmental gateways of an org

POST/api/climate/getEnvironmentalGatewayShadows

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request to retrieve environmental gateway shadows.

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/climate/getEnvironmentalGatewayShadows' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api2.rhombussystems.com/api/climate/getEnvironmentalGatewayShadows"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/climate/getEnvironmentalGatewayShadows', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {}
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/climate/getEnvironmentalGatewayShadows"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "environmentalGatewayShadows": [
    {
      "activeAlertTriggers": {
        "<key>": 0
      },
      "apMac": "<string>",
      "carbonMonoSense": {
        "adcRaw": 0,
        "adcVoltage": 0,
        "coConcentration": 0,
        "timestampSec": 0
      },
      "co2Sense": {
        "co2Ppm": 0,
        "relHumid": 0,
        "tempC": 0,
        "timestampSec": 0
      },
      "connected": true,
      "connectionTimestampMs": 0,
      "connectionUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "defaultInterface": "<string>",
      "defaultInterfaceMac": "<string>",
      "derivedValues": {
        "airQualityIndex": 0,
        "airQualityIndexPollutant": "OZONE",
        "calibrating": true,
        "deviceOrientation": "CEILING",
        "falsePositiveConfidencePercent": 0,
        "heatIndexDegF": 0,
        "heatIndexRangeWarning": "HEAT_INDEX_OK",
        "indoorAirQuality": 0,
        "malfunctioningModules": [
          "<string>"
        ],
        "smokeConfidencePercent": 0,
        "smokeThcConfidencePercent": 0,
        "smokeTobaccoConfidencePercent": 0,
        "timestampSec": 0,
        "tvoc": 0,
        "vapeConfidencePercent": 0,
        "vapeDetected": true,
        "vapeThcConfidencePercent": 0
      },
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "disconnectTimestampMs": 0,
      "externalIPAddress": "<string>",
      "firmwareUpdateInProgress": true,
      "firmwareUpdateTimeMs": 0,
      "firmwareVersion": "<string>",
      "formaSense": {
        "ch2oPpb": 0,
        "relHumid": 0,
        "tempC": 0,
        "timestampSec": 0
      },
      "hardwareUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "internalWanAddress": "<string>",
      "jumpHostUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "lanAddresses": [
        "<string>"
      ],
      "leakProbe": {
        "adcMv": 0,
        "adcRaw": 0,
        "leakDetected": true,
        "moistDetected": true,
        "present": true,
        "timestampSec": 0
      },
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "pmSense": {
        "nc0p5": 0,
        "nc10p0": 0,
        "nc1p0": 0,
        "nc2p5": 0,
        "nc4p0": 0,
        "noxIdx": 0,
        "pm10p0": 0,
        "pm1p0": 0,
        "pm2p5": 0,
        "pm4p0": 0,
        "relHumid": 0,
        "tempC": 0,
        "timestampSec": 0,
        "typPartSize": 0,
        "vocIdx": 0
      },
      "pressSense": {
        "pressure": 0,
        "tempC": 0,
        "timestampSec": 0
      },
      "prevConnected": true,
      "prevConnectedUpdateTimestampMs": 0,
      "region": "<string>",
      "secondaryLanAddresses": [
        "<string>"
      ],
      "ssid": "<string>",
      "state": {
        "<key>": {}
      },
      "stateUpdatedTimestampMs": 0,
      "tempProbe": {
        "adcMv": 0,
        "adcRaw": 0,
        "present": true,
        "tempC": 0,
        "timestampSec": 0
      },
      "timestampMs": 0,
      "type": "BLE_TRACKER",
      "wanAddress": "<string>",
      "wifiSignalStrength": 0
    }
  ],
  "error": false,
  "errorCode": "<string>"
}

Response

200 OK

application/json · object

Response containing environmental gateway shadows.

environmentalGatewayShadowsobject[] | null

List of environmental gateway shadows

Show child attributes

activeAlertTriggersobject | null

apMacstring | null

carbonMonoSenseobject

Show child attributes

adcRawinteger<int32> | null

adcVoltagenumber<double> | null

coConcentrationnumber<double> | null

timestampSecinteger<int64> | null

co2Senseobject

Show child attributes

co2Ppminteger<int32> | null

relHumidnumber<float> | null

tempCnumber<float> | null

timestampSecinteger<int64> | null

connectedboolean | null

connectionTimestampMsinteger<int64> | null

connectionUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

defaultInterfacestring | null

defaultInterfaceMacstring | null

derivedValuesobject

Show child attributes

airQualityIndexinteger<int32> | null

airQualityIndexPollutantenum<string>

Primary pollutant affecting air quality index

Available options: OZONE, PM2P5, PM10P0, CO, NO2, SO2, UNKNOWN

calibratingboolean | null

deviceOrientationenum<string>

Available options: CEILING, FLOOR, WALL, WALL_CROOKED, INDETERMINATE

falsePositiveConfidencePercentnumber<float> | null

heatIndexDegFnumber<double> | null

heatIndexRangeWarningenum<string>

Heat index range warning status

Available options: HEAT_INDEX_OK, HEAT_INDEX_WARNING, HEAT_INDEX_UNSUPPORTED

indoorAirQualitynumber<float> | null

malfunctioningModulesstring[] | null

smokeConfidencePercentnumber<float> | null

smokeThcConfidencePercentnumber<float> | null

smokeTobaccoConfidencePercentnumber<float> | null

timestampSecinteger<int64> | null

tvocnumber<float> | null

vapeConfidencePercentnumber<float> | null

vapeDetectedboolean | null

vapeThcConfidencePercentnumber<float> | null

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

disconnectTimestampMsinteger<int64> | null

externalIPAddressstring | null

firmwareUpdateInProgressboolean | null

firmwareUpdateTimeMsinteger<int64> | null

firmwareVersionstring | null

formaSenseobject

Show child attributes

ch2oPpbnumber<float> | null

relHumidnumber<float> | null

tempCnumber<float> | null

timestampSecinteger<int64> | null

hardwareUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

internalWanAddressstring | null

jumpHostUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lanAddressesstring[] | null

leakProbeobject

Show child attributes

adcMvnumber<float> | null

adcRawinteger<int64> | null

leakDetectedboolean | null

moistDetectedboolean | null

presentboolean | null

timestampSecinteger<int64> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

pmSenseobject

Show child attributes

nc0p5number<float> | null

nc10p0number<float> | null

nc1p0number<float> | null

nc2p5number<float> | null

nc4p0number<float> | null

noxIdxnumber<float> | null

pm10p0number<float> | null

pm1p0number<float> | null

pm2p5number<float> | null

pm4p0number<float> | null

relHumidnumber<float> | null

tempCnumber<float> | null

timestampSecinteger<int64> | null

typPartSizenumber<float> | null

vocIdxnumber<float> | null

pressSenseobject

Show child attributes

pressurenumber<float> | null

tempCnumber<float> | null

timestampSecinteger<int64> | null

prevConnectedboolean | null

prevConnectedUpdateTimestampMsinteger<int64> | null

regionstring | null

secondaryLanAddressesstring[] | null

ssidstring | null

stateobject | null

stateUpdatedTimestampMsinteger<int64> | null

tempProbeobject

Show child attributes

adcMvnumber<float> | null

adcRawinteger<int64> | null

presentboolean | null

tempCnumber<float> | null

timestampSecinteger<int64> | null

timestampMsinteger<int64> | null

typeenum<string>

Available options: BLE_TRACKER, CAMERA, DOOR_SENSOR, ENVIRONMENTAL_SENSOR, OCCUPANCY_SENSOR, AUDIO_GATEWAY, EXECUTABLE, BADGE_READER, DOOR_CONTROLLER, BLE_BUTTON, IO_BOARD, ENVIRONMENTAL_GATEWAY, NVR, ROBOT, UNKNOWN

wanAddressstring | null

wifiSignalStrengthinteger<int32> | null

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.