How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rhombus Systems Device Config Webservice API

The Device Config Webservice API from Rhombus Systems — 2 operation(s) for device config webservice.

Rhombus Systems Device Config Webservice API is one of 65 APIs that Rhombus Systems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Device Config Webservice. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 73 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api2.rhombussystems.com.

2 operations 2 paths 73 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api2.rhombussystems.com/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Rhombus Systems Device Config Webservice API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-auth-apikey (ApiKeyAuth). By default, every request must be authenticated.

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

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Device Config Webservice 2
POST
/api/deviceconfig/getFacetedConfig
Get a device's config
getFacetedConfig 1 param body → 200
POST
/api/deviceconfig/updateFacetedConfig
Update a device's config
updateFacetedConfig 1 param body → 200

Schemas 73

The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are Device_config_settings_ExternalReadableVideoSettings (103 properties), Device_config_settings_ExternalVideoSettingsSelectiveUpdate (69 properties), Device_config_settings_ExternalReadableAudioSettings (26 properties), Device_config_settings_ExternalAudioSettingsSelectiveUpdate (26 properties). Each schema is shown below with its type and property counts.

Device_config_settings_ExternalAudioSettingsSelectiveUpdate
object
Update Audio settings
26 properties
Device_config_userconfig_ExternalReadableFacetedUserConfig
object
Device's faceted user configuration
18 properties
Device_config_GetConfigWSRequest
object
Request object for retrieving a device's configuration.
1 property
RegionOfInterestGroup
object
3 properties
LEDModeEnum
string
RobotSettingsSelectiveUpdate
object
9 properties
CameraVisualTamperConfigType
object
7 properties
BurstyRateLimit
object
4 properties
Device_config_settings_ExternalReadableDoorControllerSettings
object
6 properties
CameraHumanLoiteringSettingsType
object
1 property
InactivityObjectTypeEnum
string
Device_config_GetFacetedUserConfigWSResponse
object
Response object containing a device's faceted user configuration.
4 properties
Device_config_settings_ExternalReadableDeviceVideoSettings
object
6 properties
ThirdPartyCameraSettings
object
11 properties
Device_config_settings_ExternalDeviceSettingsSelectiveUpdate
object
19 properties
ButtonSettingsSelectiveUpdate
object
Update Button settings
3 properties
MetricsAgentSettingsSelectiveUpdate
object
7 properties
CameraPTZConfigType
object
4 properties
CameraAiDewarpConfigType
object
3 properties
DoorReaderSettings
object
4 properties
DoorSensorSettingsSelectiveUpdate
object
3 properties
CrossingDirectionEnum
string
CrossingObjectEnum
string
Device_config_settings_ExternalReadableAudioSettings
object
26 properties
MetricsAgentSettings
object
6 properties
CameraDewarpModeEnum
string
AspectRatio
object
2 properties
Device_config_settings_ExternalDoorControllerSettingsSelectiveUpdate
object
Update Door Controller settings
7 properties
Pose
object
2 properties
CameraPTZEngineEnum
string
EnvironmentalGatewaySettings
object
12 properties
LensRoleEnum
string
WeeklyMinuteIntervalType
object
2 properties
EnvironmentalGatewaySettingsSelectiveUpdate
object
Update Environmental Sensor settings
13 properties
VideoDoorbellSettingsSelectiveUpdate
object
Update Video Doorbell settings
2 properties
DewarpedView
object
5 properties
ClimateSettingsSelectiveUpdate
object
Update Sensor Climate settings
5 properties
MetricsLevelEnum
string
CameraPTZTranslationSpaceEnum
string
CameraPTZMovementEnum
string
EmergencyContact
object
2 properties 2 required
CameraCrossCountingSettingsType
object
5 properties
FisheyeDisplayModeEnum
string
VideoDoorbellSettings
object
1 property
Device_config_settings_ExternalVideoResolution
object
2 properties
RegionConfigType
objectnull
2 properties
TamperSettingsSelectiveUpdate
object
Update Tamper detection settings
4 properties
CameraMountingDirectionEnum
string
CameraMeteringConfigType
object
2 properties
TamperSettings
object
3 properties
DeviceVideoSettingsSelectiveUpdate
object
Update selective video settings
7 properties
Device_config_userconfig_ExternalUpdateableFacetedUserConfig
object
Configuration updates to apply to the device
15 properties
RegionCoordinateType
object
2 properties
Device_config_settings_ExternalReadableDeviceSettings
object
23 properties
ActivityEnum
string
DoorSensorSettings
object
2 properties
Common_devices_UpdateConfigWSResponse
object
Response indicating the result of updating device configuration.
3 properties
IRModesEnum
string
RegionOfInterest
object
Regions of interest that belong to the group. Group must have at least one region specified.
4 properties
DoorReaderSettingsSelectiveUpdate
object
Update Door Reader settings
5 properties
ClimateSettings
object
4 properties
CameraMotorConfigType
object
8 properties
FrontendEqualizerSettings
object
3 properties
RobotSettings
object
8 properties
Device_config_UpdateFacetedUserConfigWSRequest
object
Request object for updating a device's faceted user configuration.
1 property
Device_config_settings_ExternalVideoSettingsSelectiveUpdate
object
Update Video Settings
69 properties
RegionOfInterestGroupTypeEnum
string
Represents type of activity regions in the group. Defaults to 'Activity'.
Device_config_settings_ExternalReadableButtonSettings
object
2 properties
CameraInactivitySettingsType
object
3 properties
UploadTargetEnum
string
RegionPolygonType
object
1 property
Device_config_settings_ExternalReadableVideoSettings
object
103 properties
PermyriadRect
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rhombus-systems-device-config-webservice-api-openapi.yml Raw ↑

Other APIs Rhombus Systems publishes across the network.

Rhombus Console WebSocket API
Rhombus Systems Access Control Integrations Webservice API
Rhombus Systems Access Control Webservice API
Rhombus Systems Alarm Monitoring Keypad Webservice API
Rhombus Systems Alert Monitoring Webservice API
Rhombus Systems AudioGateway Webservice API
Rhombus Systems AudioPlayback Webservice API
Rhombus Systems Badge Reader Webservice API
Rhombus Systems BLE Webservice API
Rhombus Systems Button Webservice API
Rhombus Systems Camera Webservice API
Rhombus Systems ClaimKey Webservice API
Where this information came from

This is an independent, third-party profile of Rhombus Systems Device Config Webservice API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.