Rhombus Systems Climate Webservice API
The Climate Webservice API from Rhombus Systems — 12 operation(s) for climate webservice.
The Climate Webservice API from Rhombus Systems — 12 operation(s) for climate webservice.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/rhombus-systems-climate-webservice-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
contact:
email: developer@rhombussystems.com
description: 'This API is for use by Rhombus customers and partners.
## Authentication
All requests require two headers:
- `x-auth-scheme` — The authentication scheme identifier. Use `api-token` for standard API key auth, or `partner-api-token` for partner API auth.
- `x-auth-apikey` — Your Rhombus API key.
Example:
```
POST /api/camera/getMinimalCameraStateList
x-auth-scheme: api-token
x-auth-apikey: YOUR_API_KEY
Content-Type: application/json
```'
title: Rhombus Climate Webservice API
version: '1.0'
servers:
- description: Production Server
url: https://api2.rhombussystems.com
security:
- ApiKeyAuth: []
tags:
- name: Climate Webservice
paths:
/api/climate/deleteEnvironmentalGateway:
post:
description: Remove an environmental gateway from the org
operationId: deleteEnvironmentalGateway
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_DeleteEnvironmentalGatewayWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_DeleteEnvironmentalGatewayWSResponse'
description: OK
summary: Delete environmental gateway
tags:
- Climate Webservice
/api/climate/getClimateEventsForSensor:
post:
description: Get list of climate events for environmental sensor
operationId: getClimateEventsForSensor
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_GetClimateEventsForSensorWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_GetClimateEventsForSensorWSResponse'
description: OK
summary: Get climate events for environmental sensor
tags:
- Climate Webservice
/api/climate/getClimatePresenceWindows:
post:
description: Get stored video information for sensor
operationId: getClimatePresenceWindows
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Sensor_GetSensorPresenceWindowsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Sensor_GetSensorPresenceWindowsWSResponse'
description: OK
summary: Get climate presence windows
tags:
- Climate Webservice
/api/climate/getConfig:
post:
description: Get the config for a climate sensor
operationId: getConfig
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_GetClimateSensorConfigWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_GetClimateSensorConfigWSResponse'
description: OK
summary: Get climate sensor config
tags:
- Climate Webservice
/api/climate/getEnvironmentalGatewayShadows:
post:
description: Get list of shadows of all environmental gateways of an org
operationId: getEnvironmentalGatewayShadows
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_GetEnvironmentalGatewayShadowsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_GetEnvironmentalGatewayShadowsWSResponse'
description: OK
summary: Get environmental gateway shadows
tags:
- Climate Webservice
/api/climate/getEventsForEnvironmentalGateway:
post:
description: Get list of events for environmental gateway
operationId: getEventsForEnvironmentalGateway
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_GetEventsForEnvironmentalGatewayWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_GetEventsForEnvironmentalGatewayWSResponse'
description: OK
summary: Get events for environmental gateway
tags:
- Climate Webservice
/api/climate/getMinimalClimateStateList:
post:
description: Get basic state information of all environmental sensors
operationId: getMinimalClimateStateList
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_GetMinimalClimateStatesWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_GetMinimalClimateStatesWSResponse'
description: OK
summary: Get minimal climate state list
tags:
- Climate Webservice
/api/climate/getMinimalEnvironmentalGatewayStates:
post:
description: Get list of basic states of all environmental gateways of an org
operationId: getMinimalEnvironmentalGatewayStates
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_GetMinimalEnvironmentalGatewayStatesWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_GetMinimalEnvironmentalGatewayStatesWSResponse'
description: OK
summary: Get minimal environmental gateway states
tags:
- Climate Webservice
/api/climate/getMinimalStateEventsForEnvironmentalGateway:
post:
description: Get list of events for environmental gateways in minimal state
operationId: getMinimalStateEventsForEnvironmentalGateway
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_GetEventsForEnvironmentalGatewayWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_GetMinimalEnvironmentalGatewayStatesWSResponse'
description: OK
summary: Get minimal state events for environmental gateway
tags:
- Climate Webservice
/api/climate/reboot:
post:
description: Send reboot command to environmental gateway
operationId: rebootEnvironmentalGateway
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_RebootEnvironmentalGatewayWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Common_devices_RebootDeviceWSResponse'
description: OK
summary: Reboot environmental gateway
tags:
- Climate Webservice
/api/climate/updateDetails:
post:
description: 'Update details for environmental sensor. Note: uuid is a required field'
operationId: updateClimateSensorDetails
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_UpdateClimateSensorDetailsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_UpdateClimateSensorDetailsWSResponse'
description: OK
summary: Update climate sensor details
tags:
- Climate Webservice
/api/climate/updateEnvironmentalGatewayDetails:
post:
description: 'Update details for environmental gateway. Note: uuid is a required field'
operationId: updateEnvironmentalGatewayDetails
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_UpdateEnvironmentalGatewayDetailsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Climate_UpdateEnvironmentalGatewayDetailsWSResponse'
description: OK
summary: Update environmental gateway details
tags:
- Climate Webservice
components:
schemas:
Climate_UpdateClimateSensorDetailsWSResponse:
type: object
description: Response indicating the result of updating environmental sensor details.
properties:
error:
type:
- boolean
- 'null'
errorMsg:
type:
- string
- 'null'
warningMsg:
type:
- string
- 'null'
DeviceOrientationEnum:
type: string
enum:
- CEILING
- FLOOR
- WALL
- WALL_CROOKED
- INDETERMINATE
Climate_UpdateEnvironmentalGatewayDetailsWSResponse:
type: object
description: Response indicating the result of updating environmental gateway details.
properties:
error:
type:
- boolean
- 'null'
errorMsg:
type:
- string
- 'null'
warningMsg:
type:
- string
- 'null'
AirQualityIndexPollutantEnum:
type: string
description: Primary pollutant affecting air quality index
enum:
- OZONE
- PM2P5
- PM10P0
- CO
- NO2
- SO2
- UNKNOWN
ClipSeekPointV2Type:
type: object
description: List of seek points for the clip
properties:
activity:
$ref: '#/components/schemas/ActivityEnum'
alert:
type:
- boolean
- 'null'
customActivityColor:
$ref: '#/components/schemas/FootageSeekPointColorEnum'
customActivityDescription:
type:
- string
- 'null'
customActivityDisplayName:
type:
- string
- 'null'
dcao:
type:
- boolean
- 'null'
dwelling:
type:
- boolean
- 'null'
faceName:
type:
- string
- 'null'
id:
type:
- integer
- 'null'
format: int32
inMotion:
type:
- boolean
- 'null'
licensePlate:
type:
- string
- 'null'
loudness:
type:
- integer
- 'null'
format: int32
pose:
type:
- string
- 'null'
relativeSecond:
type:
- number
- 'null'
format: float
sensorValType:
$ref: '#/components/schemas/SensorValType'
stableTrackId:
type:
- integer
- 'null'
format: int32
toastOrderIdInfo:
$ref: '#/components/schemas/ToastOrderIdType'
tu:
type:
- string
- 'null'
unidentifiedFaceId:
type:
- string
- 'null'
vehicleName:
type:
- string
- 'null'
Climate_DeleteEnvironmentalGatewayWSResponse:
type: object
description: Response indicating the result of deleting an environmental gateway.
properties:
error:
type:
- boolean
- 'null'
errorMsg:
type:
- string
- 'null'
responseStatus:
$ref: '#/components/schemas/WebResponseStatusEnum'
warningMsg:
type:
- string
- 'null'
Climate_GetEventsForEnvironmentalGatewayWSRequest:
type: object
description: Request to retrieve events for an environmental gateway.
properties:
createdAfterMs:
type:
- integer
- 'null'
format: int64
description: Timestamp in milliseconds after which events should be retrieved
example: 1640991600000
createdBeforeMs:
type:
- integer
- 'null'
format: int64
description: Timestamp in milliseconds before which events should be retrieved
example: 1640995200000
deviceUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
lastEvaluatedKey:
type:
- string
- 'null'
maxPageSize:
type:
- integer
- 'null'
format: int32
description: Maximum number of results to return per page
example: 50
PointType:
type: object
properties:
x:
type:
- integer
- 'null'
format: int32
y:
type:
- integer
- 'null'
format: int32
Climate_MinimalEnvironmentalGatewayStateType:
type: object
description: Minimal environmental gateway state information.
properties:
activities:
type:
- array
- 'null'
description: List of detected activities
items:
$ref: '#/components/schemas/ActivityEnum'
airQualityIndex:
type:
- integer
- 'null'
format: int32
description: Air quality index value
example: 45
airQualityIndexPollutant:
$ref: '#/components/schemas/AirQualityIndexPollutantEnum'
alertTriggers:
type:
- array
- 'null'
description: List of alert triggers
items:
$ref: '#/components/schemas/ActivityEnum'
associatedCameras:
type:
- array
- 'null'
description: List of associated camera device facet UUIDs
items:
type:
- string
- 'null'
format: DeviceFacetUuid
description: RUUID with optional appended facet information
example: AAAAAAAAAAAAAAAAAAAAAA.v0
calibrating:
type:
- boolean
- 'null'
description: Whether the gateway is currently calibrating
example: false
ch2oPpb:
type:
- number
- 'null'
format: float
description: Formaldehyde measurement in parts per billion
example: 15.7
co2Ppm:
type:
- integer
- 'null'
format: int32
description: CO2 measurement in parts per million
example: 450
coConcentration:
type:
- number
- 'null'
format: double
description: Carbon monoxide concentration
example: 2.1
connected:
type:
- boolean
- 'null'
description: Whether the gateway is connected
example: true
createdAtMillis:
type:
- integer
- 'null'
format: int64
description: Creation timestamp in milliseconds
example: 1640995200000
defaultInterfaceMac:
type:
- string
- 'null'
description: Default interface MAC address
example: 00:1A:2B:3C:4D:5E
deviceUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
externalIPAddress:
type:
- string
- 'null'
description: External IP address
example: 203.0.113.1
falsePositiveConfidencePercent:
type:
- number
- 'null'
format: float
description: False positive confidence percentage
example: 5.2
firmwareVersion:
type:
- string
- 'null'
description: Firmware version
example: 2.1.5
floorNumber:
type:
- integer
- 'null'
format: int32
description: Floor number
example: 2
healthDetails:
$ref: '#/components/schemas/DeviceHealthStatusDetailsEnum'
healthStatus:
$ref: '#/components/schemas/DeviceStatusEnum'
heatIndexDegF:
type:
- number
- 'null'
format: double
description: Heat index in degrees Fahrenheit
example: 85.2
heatIndexRangeWarning:
$ref: '#/components/schemas/HeatIndexRangeWarningEnum'
hwVariation:
$ref: '#/components/schemas/HardwareVariationEnum'
iaq:
type:
- number
- 'null'
format: float
description: Indoor Air Quality index
example: 85.5
lanAddresses:
type:
- array
- 'null'
description: List of LAN IP addresses
items:
type:
- string
- 'null'
description: List of LAN IP addresses
latitude:
type:
- number
- 'null'
format: double
description: Latitude coordinate
example: 37.7749
leakDetected:
type:
- boolean
- 'null'
description: Whether a leak is detected
example: false
leakProbePresent:
type:
- boolean
- 'null'
description: Whether leak probe is present
example: true
locationUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
longitude:
type:
- number
- 'null'
format: double
description: Longitude coordinate
example: -122.4194
name:
type:
- string
- 'null'
description: Name of the environmental gateway
example: Main Office Gateway
nc0p5:
type:
- number
- 'null'
format: float
description: Number concentration 0.5 measurement
example: 120.5
nc10p0:
type:
- number
- 'null'
format: float
description: Number concentration 10.0 measurement
example: 15.3
nc1p0:
type:
- number
- 'null'
format: float
description: Number concentration 1.0 measurement
example: 85.2
nc2p5:
type:
- number
- 'null'
format: float
description: Number concentration 2.5 measurement
example: 45.8
nc4p0:
type:
- number
- 'null'
format: float
description: Number concentration 4.0 measurement
example: 32.1
noxIdx:
type:
- number
- 'null'
format: float
description: Nitrogen Oxides index
example: 88.2
orgUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
pm10p0:
type:
- number
- 'null'
format: float
description: PM10.0 particulate matter measurement
example: 18.9
pm1p0:
type:
- number
- 'null'
format: float
description: PM1.0 particulate matter measurement
example: 8.5
pm2p5:
type:
- number
- 'null'
format: float
description: PM2.5 particulate matter measurement
example: 12.3
pm4p0:
type:
- number
- 'null'
format: float
description: PM4.0 particulate matter measurement
example: 15.7
policyUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
pressure:
type:
- number
- 'null'
format: float
description: Pressure measurement
example: 1013.25
probeTempC:
type:
- number
- 'null'
format: float
description: Temperature probe measurement in Celsius
example: 24.5
relHumid:
type:
- number
- 'null'
format: float
description: Relative humidity percentage
example: 45.2
serialNumber:
type:
- string
- 'null'
description: Serial number of the environmental gateway
example: EG-123456789
smokeConfidencePercent:
type:
- number
- 'null'
format: float
description: Smoke detection confidence percentage
example: 92.8
smokeTobaccoConfidencePercent:
type:
- number
- 'null'
format: float
description: Smoke tobacco detection confidence percentage
example: 88.1
subLocationsHierarchyKey:
type:
- string
- 'null'
format: SubLocationsHierarchyKey
description: 'A sequence of one or more base 64 (url-safe) uuid substrings.
These substrings are separated by dots (.).
'
example: AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA
pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$
tempC:
type:
- number
- 'null'
format: float
description: Temperature in Celsius
example: 23.5
tempProbePresent:
type:
- boolean
- 'null'
description: Whether temperature probe is present
example: true
timestampMs:
type:
- integer
- 'null'
format: int64
description: Timestamp in milliseconds
example: 1640995200000
typPartSize:
type:
- number
- 'null'
format: float
description: Typical particle size measurement
example: 2.8
vapeConfidencePercent:
type:
- number
- 'null'
format: float
description: Vape detection confidence percentage
example: 85.5
vapeDetected:
type:
- boolean
- 'null'
description: Whether vape is detected
example: false
vapeThcConfidencePercent:
type:
- number
- 'null'
format: float
description: Vape THC detection confidence percentage
example: 72.3
vocIdx:
type:
- number
- 'null'
format: float
description: Volatile Organic Compounds index
example: 125.5
DeviceStatusEnum:
type: string
enum:
- RED
- ORANGE
- YELLOW
- GREEN
Sensor_GetSensorPresenceWindowsWSResponse:
type: object
description: Response object containing stored video information for a sensor.
properties:
error:
type:
- boolean
- 'null'
errorMsg:
type:
- string
- 'null'
presenceWindows:
type:
- array
- 'null'
description: List of presence windows for the sensor
items:
$ref: '#/components/schemas/TimeWindowSeconds'
warningMsg:
type:
- string
- 'null'
Climate_GetEnvironmentalGatewayShadowsWSRequest:
type: object
description: Request to retrieve environmental gateway shadows.
Co2SensorType:
type: object
properties:
co2Ppm:
type:
- integer
- 'null'
format: int32
relHumid:
type:
- number
- 'null'
format: float
tempC:
type:
- number
- 'null'
format: float
timestampSec:
type:
- integer
- 'null'
format: int64
ClipSeekPointType:
type: object
properties:
activity:
$ref: '#/components/schemas/ActivityEnum'
alert:
type:
- boolean
- 'null'
bottom:
type:
- number
- 'null'
format: float
faceName:
type:
- string
- 'null'
keypointsV2:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/PointType'
left:
type:
- number
- 'null'
format: float
licensePlate:
type:
- string
- 'null'
pose:
type:
- string
- 'null'
relativeSecond:
type:
- number
- 'null'
format: float
right:
type:
- number
- 'null'
format: float
top:
type:
- number
- 'null'
format: float
unidentifiedFaceId:
type:
- string
- 'null'
vehicleName:
type:
- string
- 'null'
Sensor_GetSensorPresenceWindowsWSRequest:
type: object
description: Request object for retrieving stored video information for a sensor.
properties:
deviceUuid:
type:
- string
# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rhombus-systems/refs/heads/main/openapi/rhombus-systems-climate-webservice-api-openapi.yml