Skip to main content
POST
/
api
/
partner
/
customizeClientDevice
Customize client device
curl --request POST \
  --url https://api2.rhombussystems.com/api/partner/customizeClientDevice \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "clientDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "configUpdate": {
    "ai_license_invalid": true,
    "audio_aec_via_software": true,
    "audio_ai_disabled": true,
    "audio_external_mic_boost": 123,
    "audio_external_mic_volume": 123,
    "audio_external_speaker_volume": 123,
    "audio_internal_mic_aec_enabled": true,
    "audio_internal_mic_boost": 123,
    "audio_internal_mic_volume": 123,
    "audio_internal_speaker_volume": 123,
    "audio_min_echo_amplitude": 123,
    "audio_playback_gain_percent": 123,
    "audio_record": true,
    "audio_supported": true,
    "audio_use_external_mic": true,
    "audio_use_external_speaker": true,
    "audio_use_internal_speaker": true,
    "bandwidth_reports_disabled": true,
    "blocked_debounce_time_ms": 123,
    "blocked_threshold": 123,
    "char_threshold": 123,
    "custom_events": true,
    "decode_only": true,
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "device_mic_enabled": true,
    "device_near_audio_silenced": true,
    "device_speaker_enabled": true,
    "dewarpMode": "NO_TRANSFORM",
    "disabled_schedule": [
      {
        "minuteOfWeekStart": 123,
        "minuteOfWeekStop": 123
      }
    ],
    "disabled_schedule_inverted": true,
    "disabled_schedule_uuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "exposure_level": 123,
    "firmware_dev_settings": {},
    "fisheye_display_mode": "RAW",
    "floorplan_homography": [
      [
        123
      ]
    ],
    "frontendEqualizerHighShelf": {
      "frequency": 123,
      "gain": 123,
      "q": 123
    },
    "frontendEqualizerLowShelf": {
      "frequency": 123,
      "gain": 123,
      "q": 123
    },
    "frontendEqualizerPeaking1": {
      "frequency": 123,
      "gain": 123,
      "q": 123
    },
    "frontendEqualizerPeaking2": {
      "frequency": 123,
      "gain": 123,
      "q": 123
    },
    "frontendEqualizerPeaking3": {
      "frequency": 123,
      "gain": 123,
      "q": 123
    },
    "frontendNoiseSuppression": true,
    "hdr_enabled": true,
    "high_res_detection": true,
    "human_detection": true,
    "human_loitering": true,
    "human_loitering_settings": {
      "roi": [
        {
          "coordinates": [
            {
              "x": 123,
              "y": 123
            }
          ]
        }
      ]
    },
    "img_brightness": 123,
    "img_contrast": 123,
    "img_saturation": 123,
    "img_sharpness": 123,
    "lastModified": 123,
    "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_detections_per_frame": 123,
    "media_ttl_minutes": 123,
    "metering_config": {
      "rotation": 123,
      "table": "<string>"
    },
    "motor_config": {
      "af_enabled": true,
      "af_region": {
        "h": 123,
        "size": 123,
        "w": 123,
        "x": 123,
        "y": 123
      },
      "focus": 123,
      "piris": 123,
      "zoom": 123
    },
    "mounting_direction": "DOWN",
    "night_exposure_level": 123,
    "night_img_brightness": 123,
    "night_img_contrast": 123,
    "night_img_saturation": 123,
    "night_img_sharpness": 123,
    "night_metering_config": {
      "rotation": 123,
      "table": "<string>"
    },
    "night_sensor_gain_max": 123,
    "night_shutter_time_max": 123,
    "night_shutter_time_min": 123,
    "object_search": true,
    "occupancy_counting": true,
    "on_demand_license_invalid": true,
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "privacy_window_polygons": [
      {
        "coordinates": [
          {
            "x": 123,
            "y": 123
          }
        ]
      }
    ],
    "privacy_windows": [
      {
        "h": 123,
        "size": 123,
        "w": 123,
        "x": 123,
        "y": 123
      }
    ],
    "ptz_config": {
      "offset_x_percent": 123,
      "offset_y_percent": 123,
      "rotation": 123,
      "size_percent": 123
    },
    "region_for_occupancy": {
      "inverted": true,
      "polygons": [
        {
          "coordinates": [
            {
              "x": 123,
              "y": 123
            }
          ]
        }
      ]
    },
    "region_of_interest": {
      "inverted": true,
      "polygons": [
        {
          "coordinates": [
            {
              "x": 123,
              "y": 123
            }
          ]
        }
      ]
    },
    "region_of_interest_groups": [
      {
        "inclusive": true,
        "regionsOfInterest": [
          {
            "activities": [
              "SOUND_LOUD"
            ],
            "name": "<string>",
            "polygon": {
              "coordinates": [
                {
                  "x": 123,
                  "y": 123
                }
              ]
            },
            "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
          }
        ],
        "type": "ACTIVITY"
      }
    ],
    "resolution": {
      "height": 123,
      "width": 123
    },
    "rotation": 123,
    "segment_max_bytes": 123,
    "sensor_gain_max": 123,
    "shutter_time_max": 123,
    "shutter_time_min": 123,
    "snapshot_height": 123,
    "snapshot_interval_secs": 123,
    "snapshot_upload_target": "0",
    "storage_target_free_megabytes": 123,
    "storage_target_free_space_permyriad": 123,
    "thumbstrip_upload_target": "0",
    "tile_views": [
      {
        "aspectRatio": {
          "height": 123,
          "width": 123
        },
        "pitchDegrees": 123,
        "rollDegrees": 123,
        "verticalFieldOfViewDegrees": 123,
        "yawDegrees": 123
      }
    ],
    "upload_all_detections": true,
    "use_onboard_lpr": true,
    "vehicle_detection": true,
    "video_ai_disabled": true,
    "video_persist_disabled": true,
    "wdr_enabled": true,
    "wdr_strength": 123,
    "zero_motion_video_bitrate_percent": 123
  },
  "customizations": {
    "forceLowBandwidthOnAllCameras": false,
    "inactivityTimeout": 30
  }
}
'
{
  "customizations": {
    "forceLowBandwidthOnAllCameras": false,
    "inactivityTimeout": 30
  },
  "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 customizing client device settings and configurations.

clientDeviceUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

clientOrgUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

configUpdate
object

Audio/video user configuration update

customizations
object

Client device-specific customization settings for partner management.

Response

200 - application/json

OK

Response object containing the applied client device customization settings.

customizations
object

Client-specific customization settings for partner management.

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