Skip to main content
POST
/
api
/
deviceconfig
/
getFacetedConfig
Get a device's config
curl --request POST \
  --url https://api2.rhombussystems.com/api/deviceconfig/getFacetedConfig \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "config": {
    "audioFacetSettings": {},
    "buttonSettings": {
      "button_emergency_onsite_contact": {
        "name": "<string>",
        "phoneNumber": "<string>"
      },
      "button_test_mode_enabled": true
    },
    "climateSettings": {
      "alert_window_minutes": 123,
      "smoke_ai_threshold": 123,
      "thc_ai_threshold": 123,
      "vape_ai_threshold": 123
    },
    "deviceSettings": {
      "ai_license_invalid": true,
      "bandwidth_reports_disabled": true,
      "cloud_archive_days": 123,
      "cloud_archive_upload_schedule": [
        {
          "minuteOfWeekStart": 123,
          "minuteOfWeekStop": 123
        }
      ],
      "cloud_archive_upload_schedule_inverted": true,
      "cloud_archive_upload_schedule_uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "firmware_dev_settings": {},
      "led_mode_blink_period_ms": 123,
      "led_mode_when_active": "LED_OFF",
      "led_mode_when_inactive": "LED_OFF",
      "led_stealth_mode": true,
      "lightweight_detection_disabled": true,
      "live_license_invalid": true,
      "max_event_duration_ms": 123,
      "media_ttl_minutes": 123,
      "on_demand_license_invalid": true,
      "scanner_agent_disabled": true,
      "snapshot_upload_target": "0",
      "storage_target_free_megabytes": 123,
      "storage_target_free_space_permyriad": 123,
      "thumbstrip_upload_target": "0"
    },
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "deviceVideoSettings": {
      "alert_rate_limit_human_only": {
        "base_interval_ms": 123,
        "burst_token_generation_ms": 123,
        "burst_token_initial_count": 123,
        "burst_token_max_count": 123
      },
      "alert_rate_limit_motion_only": {
        "base_interval_ms": 123,
        "burst_token_generation_ms": 123,
        "burst_token_initial_count": 123,
        "burst_token_max_count": 123
      },
      "alert_rate_limit_vehicle_only": {
        "base_interval_ms": 123,
        "burst_token_generation_ms": 123,
        "burst_token_initial_count": 123,
        "burst_token_max_count": 123
      },
      "ir_double_tap": true,
      "ir_filter_mode": "ON",
      "ir_leds_mode": "ON"
    },
    "doorControllerSettings": {
      "autocomponentize_readers": true,
      "autoregister_readers": true,
      "flip_display_orientation": true,
      "pressure_switch_tamper_normally_open": true,
      "proximity_sensor_tamper_disabled": true,
      "proximity_sensor_tamper_distance_threshold": 123
    },
    "doorReaderSettings": {
      "dr_enable_audio_feedback": true,
      "tof_max_distance": 123,
      "tof_min_distance": 123,
      "tof_min_signal_over_noise": 123
    },
    "doorSensorSettings": {
      "ajar_threshold_enabled": true,
      "ajar_threshold_sec": 123
    },
    "environmentalGatewaySettings": {
      "data_measurement_interval_sec": 123,
      "data_upload_interval_sec": 123,
      "false_positive_confidence_threshold": 123,
      "leak_detection_threshold": 123,
      "leak_detector_present": true,
      "moist_detection_threshold": 123,
      "smoke_confidence_threshold": 123,
      "smoke_thc_confidence_threshold": 123,
      "smoke_tobacco_confidence_threshold": 123,
      "vape_alert_backoff_sec": 123,
      "vape_confidence_threshold": 123,
      "vape_thc_confidence_threshold": 123
    },
    "lastModified": 123,
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "robotSettings": {
      "home_latitude": 123,
      "home_longitude": 123,
      "map_created_at_ms": 123,
      "map_id": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "tamperSettings": {
      "accelerometer_change_tamper_threshold": 123,
      "accelerometer_disabled": true,
      "pressure_switch_tamper_disabled": true
    },
    "thirdPartyCameraSettings": {
      "onvif_ip": "<string>",
      "onvif_password": "<string>",
      "onvif_profiletoken": "<string>",
      "onvif_ptz_servicepath": "<string>",
      "onvif_username": "<string>",
      "ptz_engine": "DIGITAL",
      "ptz_movement": "RELATIVE",
      "ptz_translation_space": "FOV"
    },
    "videoDoorbellSettings": {
      "standalone_doorbell_mode": true
    },
    "videoFacetSettings": {}
  },
  "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 object for retrieving a device's configuration.

deviceUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object containing a device's faceted user configuration.

config
object

Configuration for the robot

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