Skip to content
Developers
Get API KeyGet API Key(opens in a new tab)

Device Config

Get a device's config

Get a device's config

POST/api/deviceconfig/getFacetedConfig

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 object for retrieving a device's configuration.

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Response

200 OK

application/json · object

Response object containing a device's faceted user configuration.

configobject

Device's faceted user configuration

Show child attributes
audioFacetSettingsobject | null
Show child attributes
audio_aec_via_softwareboolean | null
audio_ai_disabledboolean | null
audio_analysis_enabledboolean | null
audio_external_mic_boostinteger<int32> | null
audio_external_mic_volumeinteger<int32> | null
audio_external_speaker_volumeinteger<int32> | null
audio_internal_mic_aec_enabledboolean | null
audio_internal_mic_boostinteger<int32> | null
audio_internal_mic_volumeinteger<int32> | null
audio_internal_speaker_volumeinteger<int32> | null
audio_min_echo_amplitudeinteger<int32> | null
audio_playback_gain_percentinteger<int32> | null
audio_recordboolean | null
audio_supportedboolean | null
audio_use_external_micboolean | null
audio_use_external_speakerboolean | null
audio_use_internal_speakerboolean | null
device_mic_enabledboolean | null
device_near_audio_silencedboolean | null
device_speaker_enabledboolean | null
frontendEqualizerHighShelfobject
Show child attributes
frequencyinteger<int32> | null
gaininteger<int32> | null
qinteger<int32> | null
frontendEqualizerLowShelfobject
Show child attributes
frequencyinteger<int32> | null
gaininteger<int32> | null
qinteger<int32> | null
frontendEqualizerPeaking1object
Show child attributes
frequencyinteger<int32> | null
gaininteger<int32> | null
qinteger<int32> | null
frontendEqualizerPeaking2object
Show child attributes
frequencyinteger<int32> | null
gaininteger<int32> | null
qinteger<int32> | null
frontendEqualizerPeaking3object
Show child attributes
frequencyinteger<int32> | null
gaininteger<int32> | null
qinteger<int32> | null
frontendNoiseSuppressionboolean | null
buttonSettingsobject
Show child attributes
button_emergency_onsite_contactobject
Show child attributes
namestring | nullrequired

The name of the emergency contact.

phoneNumberstring | nullrequired

The phone number for this emergency contact.

button_test_mode_enabledboolean | null
climateSettingsobject
Show child attributes
alert_window_minutesinteger<int32> | null
smoke_ai_thresholdnumber<float> | null
thc_ai_thresholdnumber<float> | null
vape_ai_thresholdnumber<float> | null
deviceSettingsobject
Show child attributes
ai_license_invalidboolean | null
bandwidth_reports_disabledboolean | null
cloud_ai_smart_crop_enabledboolean | null
cloud_ai_stream_enabledboolean | null
cloud_archive_daysinteger<int32> | null
cloud_archive_upload_scheduleobject[] | null
Show child attributes
minuteOfWeekStartinteger<int32> | null
minuteOfWeekStopinteger<int32> | null
cloud_archive_upload_schedule_invertedboolean | null
cloud_archive_upload_schedule_uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

core_event_upload_targetenum<string>

Available options: 0, 1, 2

firmware_dev_settingsobject | null
led_mode_blink_period_msinteger<int64> | null
led_mode_when_activeenum<string>

Available options: LED_OFF, LED_RED_SOLID, LED_GREEN_SOLID, LED_ORANGE_SOLID, LED_RED_BLINK, LED_GREEN_BLINK, LED_ORANGE_BLINK, LED_NORMAL

led_mode_when_inactiveenum<string>

Available options: LED_OFF, LED_RED_SOLID, LED_GREEN_SOLID, LED_ORANGE_SOLID, LED_RED_BLINK, LED_GREEN_BLINK, LED_ORANGE_BLINK, LED_NORMAL

led_stealth_modeboolean | null
lightweight_detection_disabledboolean | null
live_license_invalidboolean | null
max_event_duration_msinteger<int32> | null
media_ttl_minutesinteger<int32> | null
on_demand_license_invalidboolean | null
scanner_agent_disabledboolean | null
snapshot_upload_targetenum<string>

Available options: 0, 1, 2

storage_target_free_megabytesinteger<int32> | null
storage_target_free_space_permyriadinteger<int32> | null
thumbstrip_upload_targetenum<string>

Available options: 0, 1, 2

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceVideoSettingsobject
Show child attributes
alert_rate_limit_human_onlyobject
Show child attributes
base_interval_msinteger<int32> | null
burst_token_generation_msinteger<int32> | null
burst_token_initial_countinteger<int32> | null
burst_token_max_countinteger<int32> | null
alert_rate_limit_motion_onlyobject
Show child attributes
base_interval_msinteger<int32> | null
burst_token_generation_msinteger<int32> | null
burst_token_initial_countinteger<int32> | null
burst_token_max_countinteger<int32> | null
alert_rate_limit_vehicle_onlyobject
Show child attributes
base_interval_msinteger<int32> | null
burst_token_generation_msinteger<int32> | null
burst_token_initial_countinteger<int32> | null
burst_token_max_countinteger<int32> | null
ir_double_tapboolean | null
ir_filter_modeenum<string>

Available options: ON, OFF, AUTO

ir_leds_modeenum<string>

Available options: ON, OFF, AUTO

doorControllerSettingsobject
Show child attributes
autocomponentize_readersboolean | null
autoregister_readersboolean | null
flip_display_orientationboolean | null
mdns_advertise_enabledboolean | null
mdns_discover_enabledboolean | null
peer_address_modeenum<string>

Available options: STRICT, HINT

peer_channel_modeenum<string>

Available options: DISABLED, PASSIVE, ENABLED

pressure_switch_tamper_normally_openboolean | null
proximity_sensor_tamper_disabledboolean | null
proximity_sensor_tamper_distance_thresholdnumber<float> | null
doorReaderSettingsobject
Show child attributes
dr_enable_audio_feedbackboolean | null
tof_max_distancenumber<float> | null
tof_min_distancenumber<float> | null
tof_min_signal_over_noisenumber<float> | null
doorSensorSettingsobject
Show child attributes
ajar_threshold_enabledboolean | null

Option to Enabled or Disable the Ajar Threshold. Defaults to Disabled (False).

ajar_threshold_secinteger<int32> | null

Threshold value for Door Sensor Ajar state. Defaults to 30s.

environmentalGatewaySettingsobject
Show child attributes
data_measurement_interval_secinteger<int64> | null
data_upload_interval_secinteger<int64> | null
false_positive_confidence_thresholdnumber<float> | null
leak_detection_thresholdnumber<float> | null
leak_detector_presentboolean | null
moist_detection_thresholdnumber<float> | null
smoke_confidence_thresholdnumber<float> | null
smoke_thc_confidence_thresholdnumber<float> | null
smoke_tobacco_confidence_thresholdnumber<float> | null
vape_alert_backoff_secinteger<int64> | null
vape_confidence_thresholdnumber<float> | null
vape_thc_confidence_thresholdnumber<float> | null
lastModifiedinteger<int64> | null
metricsAgentSettingsobject
Show child attributes
batch_onboolean | nulldefault: true
batch_sizeinteger<int32> | nulldefault: 100000

Range: 10000 to 1000000

count_flush_intervalinteger<int32> | nulldefault: 1

Range: 1 to …

levelenum<string>default: ESSENTIAL

Available options: OFF, FILE, ESSENTIAL, BASIC, FULL

log_update_intervalinteger<int32> | nulldefault: 1800

Range: 1 to …

server_flush_intervalinteger<int32> | nulldefault: 15

Range: 1 to …

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

robotSettingsobject
Show child attributes
battery_recovered_threshold_pctinteger<int32> | null
home_latitudenumber<double> | null
home_longitudenumber<double> | null
low_battery_threshold_pctinteger<int32> | null
map_assigned_at_msinteger<int64> | null
map_assignment_idstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

map_idstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

poseobject
Show child attributes
orientationnumber<double>[] | null

Items: 4 to 4

positionnumber<double>[] | null

Items: 3 to 3

preferred_localization_engineenum<string>

Available options: AMCL, RTABMAP

tamperSettingsobject
Show child attributes
accelerometer_change_tamper_thresholdnumber<float> | null
accelerometer_disabledboolean | null
pressure_switch_tamper_disabledboolean | null
thirdPartyCameraSettingsobject
Show child attributes
lens_roleenum<string>

Available options: VISIBLE, THERMAL

onvif_ipstring | null
onvif_passwordstring | null
onvif_profiletokenstring | null
onvif_ptz_servicepathstring | null
onvif_usernamestring | null
ptz_engineenum<string>

Available options: DIGITAL, MECHANICAL, NONE, UNKNOWN

ptz_movementenum<string>

Available options: RELATIVE, ABSOLUTE

ptz_translation_spaceenum<string>

Available options: FOV, DIGITAL, NONE, UNKNOWN

zoom_maxnumber<double> | null
zoom_minnumber<double> | null
videoDoorbellSettingsobject
Show child attributes
standalone_doorbell_modeboolean | null
videoFacetSettingsobject | null
Show child attributes
ai_dewarp_configobject
Show child attributes
dewarp_tile_heightinteger<int32> | null
dewarp_tile_widthinteger<int32> | null
orientationinteger<int32> | null
behavior_detectionboolean | null
blocked_debounce_time_msinteger<int32> | null
blocked_thresholdnumber<float> | null
char_thresholdnumber<float> | null
color_detectionboolean | null
con_human_filterinteger<int32> | null
con_vehicle_filterinteger<int32> | null
cross_countingboolean | null
cross_counting_settingsobject
Show child attributes
directionsenum<string>[] | null
in_roiobject[] | null
Show child attributes
coordinatesobject[] | null
Show child attributes
xnumber<float> | null
ynumber<float> | null
object_typeenum<string>

Available options: HUMAN, VEHICLE, FACE, LPR, POSE, CLIP_EMBED, UNKNOWN

object_type_idinteger<int32> | null
out_roiobject[] | null
Show child attributes
coordinatesobject[] | null
Show child attributes
xnumber<float> | null
ynumber<float> | null
crossing_regionsobject[] | null
Show child attributes
directionsenum<string>[] | null
enabledboolean | null
in_roiobject
Show child attributes
coordinatesobject[] | null
Show child attributes
xnumber<float> | null
ynumber<float> | null
namestring | null
object_typeenum<string>

Available options: HUMAN, VEHICLE, FACE, LPR, POSE, CLIP_EMBED, UNKNOWN

out_roiobject
Show child attributes
coordinatesobject[] | null
Show child attributes
xnumber<float> | null
ynumber<float> | null
uuidstring | null
custom_eventsboolean | null
dewarpModeenum<string>

Available options: NO_TRANSFORM, NORMAL, PANORAMA, SUB_REGION, VERTICAL_PANORAMA, TRANSVERSE_MERCATOR, MERCATOR, EQUIRECTANGULAR

disabled_scheduleobject[] | null
Show child attributes
minuteOfWeekStartinteger<int32> | null
minuteOfWeekStopinteger<int32> | null
disabled_schedule_invertedboolean | null
disabled_schedule_uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

dwell_reset_ttl_msinteger<int64> | null
dwell_time_msinteger<int64> | null
engagement_countingboolean | null
exposure_levelinteger<int32> | null
face_ai_thresholdnumber<float> | null
face_countingboolean | null
face_counting_nonuniqueboolean | null
face_id_ai_thresholdnumber<float> | null
face_match_thresholdnumber<float> | null
face_recognitionboolean | null
fisheye_display_modeenum<string>

Available options: RAW, IMMERSIVE, TILES, RAW_PANO

floorplan_homographynumber<double>[][] | null
h265_realtime_encoding_enabledboolean | null
h265_vod_encoding_enabledboolean | null
hdr_enabledboolean | null
high_res_detectionboolean | null
human_detectionboolean | null
human_loiteringboolean | null
human_loitering_settingsobject
Show child attributes
roiobject[] | null
Show child attributes
coordinatesobject[] | null
Show child attributes
xnumber<float> | null
ynumber<float> | null
img_brightnessinteger<int32> | null
img_contrastinteger<int32> | null
img_saturationinteger<int32> | null
img_sharpnessinteger<int32> | null
inactivity_settingsobject
Show child attributes
object_typeenum<string>

Available options: HUMAN, VEHICLE

roiobject
Show child attributes
coordinatesobject[] | null
Show child attributes
xnumber<float> | null
ynumber<float> | null
threshold_msinteger<int64> | null
licenseplate_detectionboolean | null
lpr_ai_thresholdnumber<float> | null
max_detections_per_frameinteger<int32> | null
metering_configobject
Show child attributes
rotationinteger<int32> | null
tablestring | null
motion_grid_disabledboolean | null
motion_grid_window_secinteger<int32> | null
motion_lightweight_disabledboolean | null
motion_thresholdnumber<float> | null
motor_configobject
Show child attributes
af_enabledboolean | null
af_regionobject
Show child attributes
hinteger<int32> | null
sizeinteger<int32> | null
winteger<int32> | null
xinteger<int32> | null
yinteger<int32> | null
focusinteger<int32> | null
pan_degreesnumber<float> | null
pirisinteger<int32> | null
pt_speedinteger<int32> | null
tilt_degreesnumber<float> | null
zoominteger<int32> | null
mounting_directionenum<string>

Available options: DOWN, UP, SIDEWAYS, UNKNOWN

new_motion_feature_flagboolean | null
night_exposure_levelinteger<int32> | null
night_img_brightnessinteger<int32> | null
night_img_contrastinteger<int32> | null
night_img_saturationinteger<int32> | null
night_img_sharpnessinteger<int32> | null
night_metering_configobject
Show child attributes
rotationinteger<int32> | null
tablestring | null
night_sensor_gain_maxinteger<int32> | null
night_shutter_time_maxinteger<int32> | null
night_shutter_time_mininteger<int32> | null
obj_ai_thresholdnumber<float> | null
object_searchboolean | null
occupancy_count_high_thresholdinteger<int32> | null
occupancy_count_low_thresholdinteger<int32> | null
occupancy_countingboolean | null
people_countingboolean | null
people_trackingboolean | null
person_ai_thresholdnumber<float> | null
person_reidentificationboolean | null
pose_detectionboolean | null
ppe_detectionboolean | null
privacy_window_polygonsobject[] | null
Show child attributes
coordinatesobject[] | null
Show child attributes
xnumber<float> | null
ynumber<float> | null
privacy_windowsobject[] | null
Show child attributes
hinteger<int32> | null
sizeinteger<int32> | null
winteger<int32> | null
xinteger<int32> | null
yinteger<int32> | null
ptz_configobject
Show child attributes
offset_x_percentnumber<float> | null
offset_y_percentnumber<float> | null
rotationinteger<int32> | null
size_percentnumber<float> | null
ptz_homeobject
Show child attributes
go_home_seqinteger<int64> | null
pan_degreesnumber<float> | null
tilt_degreesnumber<float> | null
zoominteger<int32> | null
record_on_motionboolean | null
region_for_occupancyobject | null
Show child attributes
invertedboolean | null
polygonsobject[] | null
Show child attributes
coordinatesobject[] | null
Show child attributes
xnumber<float> | null
ynumber<float> | null
region_of_interestobject | null
Show child attributes
invertedboolean | null
polygonsobject[] | null
Show child attributes
coordinatesobject[] | null
Show child attributes
xnumber<float> | null
ynumber<float> | null
region_of_interest_groupsobject[] | null
Show child attributes
inclusiveboolean | null

If true, regions in this group include specified activities. If false, regions in this group exclude specified activities.

regionsOfInterestobject[] | null

Regions of interest that belong to the group. Group must have at least one region specified.

Show child attributes
activitiesenum<string>[] | null

Region of allowed or disallowed activities. Activities are allowed if region group is inclusive. Activities are disallowed if region group is exclusive. Region must have at least one activity specified.

namestring | null
polygonobject
Show child attributes
coordinatesobject[] | null
Show child attributes
xnumber<float> | null
ynumber<float> | null
uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

scheduleUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>

Represents type of activity regions in the group. Defaults to 'Activity'.

Available options: ACTIVITY, REPORTING, CROSSING, ALARM_MONITORING, UNKNOWN

resolutionobject
Show child attributes
heightinteger<int32> | null
widthinteger<int32> | null
rotationinteger<int32> | null
rtsp_encoderinteger<int32> | null
segment_max_bytesinteger<int32> | null
sensor_gain_maxinteger<int32> | null
shared_fovstring<DeviceFacetUuid>[] | null
shutter_time_maxinteger<int32> | null
shutter_time_mininteger<int32> | null
snapshot_heightinteger<int32> | null
snapshot_interval_secsinteger<int32> | null
target_ai_fpsinteger<int32> | null
thumbstrip_disabledboolean | null
tile_viewsobject[] | null
Show child attributes
aspectRatioobject
Show child attributes
heightinteger<int32> | null
widthinteger<int32> | null
pitchDegreesnumber<float> | null
rollDegreesnumber<float> | null
verticalFieldOfViewDegreesinteger<int32> | null
yawDegreesnumber<float> | null
timelapseboolean | null
upload_all_detectionsboolean | null
use_onboard_aiboolean | null
use_onboard_lprboolean | null
use_pilot_face_idboolean | null
vehicle_ai_thresholdnumber<float> | null
vehicle_countingboolean | null
vehicle_detectionboolean | null
video_ai_disabledboolean | null
video_persist_disabledboolean | null
visual_tamper_configobject
Show child attributes
analyze_fpsinteger<int32> | null
analyze_resinteger<int32> | null
canny_threshnumber<float> | null
edge_cov_diff_threshnumber<float> | null
enabledboolean | null
long_buf_sizeinteger<int32> | null
short_buf_sizeinteger<int32> | null
wdr_enabledboolean | null
wdr_strengthinteger<int32> | null
zero_motion_video_bitrate_percentinteger<int32> | null
zero_motion_video_qualityinteger<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.