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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Rhombus Systems

Rhombus Systems Relay Webservice API

The Relay Webservice API from Rhombus Systems — 27 operation(s) for relay webservice.

Documentation Provider Profile APIs.io OpenAPI GitHub

Rhombus Systems Relay 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 Relay Webservice. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 27 operations across 27 paths, and defines 78 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.

27 operations 27 paths 78 schemas 27 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
Contact
developer@rhombussystems.com
Resource Areas
1

Authentication & Security 1

Rhombus Systems Relay 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 27

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

Relay Webservice 27
POST
/api/relay/addThirdPartyCameraViaOnvif
Add third party camera via ONVIF
addThirdPartyCameraViaOnvif 1 param body → 200
POST
/api/relay/assignThirdPartyCameraToNVR
Assign third party camera to NVR
assignThirdPartyCameraToNVR 1 param body → 200
POST
/api/relay/assignThirdPartyCameraToRelayCamera
Assign third party camera to relay camera
assignThirdPartyCameraToRelayCamera 1 param body → 200
POST
/api/relay/assignThirdPartyMultiFacetCameraToNVR
Assign multi-facet third party camera to NVR
assignThirdPartyMultiFacetCameraToNVR 1 param body → 200
POST
/api/relay/authenticateThirdPartyCamera
Authenticate third party camera
authenticateThirdPartyCamera 1 param body → 200
POST
/api/relay/createThirdPartyCameraPassword
Create third party camera password
createThirdPartyCameraPassword 1 param body → 200
POST
/api/relay/deleteThirdPartyCameraDiscovery
Delete third party camera discovery
deleteThirdPartyCameraDiscovery 1 param body → 200
POST
/api/relay/deleteThirdPartyCameraPassword
Delete third party camera password
deleteThirdPartyCameraPassword 1 param body → 200
POST
/api/relay/executeThirdPartyCameraDiscovery
Execute third party camera discovery
executeThirdPartyCameraDiscovery 1 param body → 200
POST
/api/relay/findDiscoveriesWithUnassignedRtspEndpoints
Find discoveries with unassigned RTSP endpoints
findDiscoveriesWithUnassignedRtspEndpoints 1 param body → 200
POST
/api/relay/getAssignedThirdPartyCameras
Get assigned third party cameras
getAssignedThirdPartyCameras 1 param body → 200
POST
/api/relay/getDetails
Get NVR details
getNVRDetails 1 param body → 200
POST
/api/relay/getFullNVRState
Get full NVR state
getFullNVRState 1 param body → 200
POST
/api/relay/getMinimalNVRStateList
Get minimal NVR state list
getMinimalNVRStateList 1 param body → 200
POST
/api/relay/getMinimalThirdPartyCameraStateList
Get minimal third party camera state list
getMinimalThirdPartyCameraStateList 1 param body → 200
POST
/api/relay/getRtspEndpoints
Get RTSP endpoints
getRtspEndpoints 1 param body → 200
POST
/api/relay/getThirdPartyCameraDiscoveryScanStatus
Get third party camera discovery scan status
getThirdPartyCameraDiscoveryScanStatus 1 param body → 200
POST
/api/relay/getThirdPartyCameraPasswords
Get third party camera passwords
getThirdPartyCameraPasswords 1 param body → 200
POST
/api/relay/getUptimeWindows
Get uptime information for an NVR.
getRelayUptimeWindows 1 param body → 200
POST
/api/relay/manualDiscoverCamera
Manual discover camera
manualDiscoverCamera 1 param body → 200
POST
/api/relay/ptzMove
PTZ move
ptzMove 1 param body → 200
POST
/api/relay/ptzStatus
PTZ status
ptz 1 param body → 200
POST
/api/relay/reboot
Reboot NVR
rebootNVR 1 param body → 200
POST
/api/relay/unassignThirdPartyCamera
Unassign third party camera
unassignThirdPartyCamera 1 param body → 200
POST
/api/relay/unregister
Unregister NVR
unregisterNVR 1 param body → 200
POST
/api/relay/updateDetailsV2
Update NVR details V2
updateNVRDetailsV2 1 param body → 200
POST
/api/relay/updateFirmware
Update NVR firmware
updateNVRFirmware 1 param body → 200

Schemas 78

The contract defines 78 schemas that model the data the API accepts and returns. The most detailed are Relay_MinimalThirdPartyCameraStateType (44 properties), FullDeviceStateType (44 properties), MinimalNVRStateType (36 properties), Relay_NVRExternalType (28 properties). Each schema is shown below with its type and property counts.

Relay_AssignThirdPartyCameraToNVRWSRequest
object
Request object for assigning a third-party camera to an NVR.
5 properties
Relay_RebootNVRVWSResponse
object
Response object for rebooting an NVR.
4 properties
Relay_GetNVRDetailsWSResponse
object
Response object containing details for specified NVRs.
4 properties
Relay_GetAssignedThirdPartyCamerasWSResponse
object
Response object containing third-party cameras assigned to a specific NVR.
4 properties
Relay_AssignThirdPartyMultiFacetCameraToNVRWSResponse
object
Response object for assigning a multi-sensor third-party camera as one multi-facet camera.
5 properties
DeviceFacetEnum
string
facet information for media
Relay_GetRtspEndpointsWSResponse
object
Response object containing RTSP endpoints for a device with the specified MAC address.
1 property
LensRoleEnum
string
Relay_UnregisterNVRWSRequest
object
Request object for unregistering an NVR from the system.
1 property
Relay_AddThirdPartyCameraViaOnvifWSResponse
object
Result of adding a third-party camera via ONVIF.
13 properties
Relay_UpdateNVRWSResponse
object
Response object for updating NVR details.
3 properties
Relay_GetNVRDetailsWSRequest
object
Request object for getting details for specified NVRs.
1 property
ThirdPartyCameraPasswordType
object
List of third-party camera passwords
5 properties
Relay_DiscoveryWithUnassignedRtspEndpoints
object
Discovery information with unassigned RTSP endpoints available for assignment.
7 properties
Relay_PTZStatusWSResponse
object
Response object containing PTZ status of a camera.
6 properties
UrlStatusEnum
string
Status of the RTSP URL validation
Common_devices_GetUptimeWindowsWSResponse
object
Response containing uptime information for a device.
4 properties
Relay_ExternalRtspEndpoint
object
External RTSP endpoint configuration for camera streams.
8 properties
Relay_CreateThirdPartyCameraPasswordWSResponse
object
Response object for creating a third-party camera password.
4 properties
RtspEndpointSourceEnum
string
Relay_DeleteThirdPartyCameraPasswordWSResponse
object
Response object for deleting a third-party camera password.
3 properties
Relay_GetMinimalNVRStateListWSResponse
object
Response object containing basic state information about all NVRs in the organization.
4 properties
Relay_FindDiscoveriesWithUnassignedRtspEndpointsWSRequest
object
Request object for finding discoveries with unassigned RTSP endpoints.
Relay_GetMinimalThirdPartyCameraStateListWSResponse
object
Response object containing basic state information about all third-party cameras in the organization.
4 properties
DeviceTypeEnum
string
Relay_GetRtspEndpointsWSRequest
object
Request object for getting RTSP endpoints for a device with the specified MAC address.
1 property
Relay_AuthenticateThirdPartyCameraWSRequest
object
Request object for authenticating a third-party camera with RTSP URL.
6 properties
CameraType
object
List of third-party cameras assigned to the specified NVR
27 properties
Relay_IpProbeResultType
object
Result of probing a single IP address during third-party camera discovery.
10 properties
Relay_ManualDiscoverThirdPartyCameraWSRequest
object
Request object for manually discovering a third-party camera with RTSP URL.
5 properties
Relay_PTZStatusWSRequest
object
Request object for getting PTZ status of a camera.
1 property
Common_devices_GetUptimeWindowsWSRequest
object
Request to get uptime information for a device.
3 properties
Relay_UpdateNVRWSRequest
object
Request object for updating NVR details.
18 properties
Relay_DeleteThirdPartyCameraDiscoveryWSResponse
object
Request object for creating a third-party camera password.
FullDeviceStateType
object
Detailed state information for the specified NVR
44 properties
Relay_GetMinimalNVRStateListWSRequest
object
Request object for getting basic state information about all NVRs in the organization.
Common_devices_RebootDeviceWSResponse_RebootResult
string
Result of the reboot operation
Relay_CreateThirdPartyCameraPasswordWSRequest
object
Request object for creating a third-party camera password.
3 properties
Relay_MinimalThirdPartyCameraStateType
object
Minimal third-party camera state information.
44 properties
Relay_GetMinimalThirdPartyCameraStateListWSRequest
object
Request object for getting basic state information about all third-party cameras in the organization.
Relay_UnassignThirdPartyCameraWSResponse
object
Response object for unassigning a third-party camera from an NVR.
3 properties
Relay_PTZMoveWSRequest
object
Request object for moving a PTZ camera.
4 properties
Relay_FindDiscoveriesWithUnassignedRtspEndpointsWSResponse
object
Response object containing discoveries with unassigned RTSP endpoints.
1 property
Relay_AssignThirdPartyCameraToRelayCameraWSResponse
object
Response object for assigning a third-party camera to a relay camera.
4 properties
Relay_GetThirdPartyCameraDiscoveryScanStatusWSResponse
object
Progress of the current/most-recent third-party camera discovery run.
11 properties
Relay_UpdateNVRFirmwareWSResponse
object
Response object for updating NVR firmware.
4 properties
Relay_GetThirdPartyCameraPasswordsWSRequest
object
Request object for getting third-party camera passwords.
Relay_RebootNVRVWSRequest
object
Request object for rebooting an NVR.
1 property
Relay_UnregisterNVRWSResponse
object
Response object for unregistering an NVR from the system.
4 properties
Relay_UpdateNVRFirmwareWSRequest
object
Request object for updating NVR firmware.
1 property
Relay_AssignThirdPartyCameraToNVRWSResponse
object
Response object for assigning a third-party camera to an NVR.
4 properties
HardwareVariationEnum
string
Relay_AssignThirdPartyMultiFacetCameraToNVRWSRequest
object
Request to assign a multi-sensor third-party camera to an NVR as one multi-facet camera.
5 properties
Relay_ExecuteThirdPartyCameraDiscoveryWSRequest
object
Request object for executing third-party camera discovery.
3 properties
Relay_GetThirdPartyCameraPasswordsWSResponse
object
Response object containing third-party camera passwords.
4 properties
TimeWindowSeconds
object
List of uptime windows for the device
2 properties
DiscoveredThirdPartyCameraType
object
The imported (discovered) third-party camera. This field is populated only if the RTSP URL specified in the import resulted in creation of a new discovery or a…
16 properties
Relay_GetThirdPartyCameraDiscoveryScanStatusWSRequest
object
Request object for getting the progress of the current/most-recent third-party camera discovery run in the organization.
Relay_UnassignThirdPartyCameraWSRequest
object
Request object for unassigning a third-party camera from an NVR.
3 properties
Relay_NvrScanProgressType
object
Live scan progress for a single Relay (NVR) within a discovery run.
11 properties
Relay_GetFullNVRStateWSResponse
object
Response object containing detailed information about the state of a specified NVR.
4 properties
MinimalNVRStateType
object
List of minimal NVR state information for all NVRs in the organization
36 properties
DeviceStatusEnum
string
Relay_ExecuteThirdPartyCameraDiscoveryWSResponse
object
Response object for executing third-party camera discovery.
4 properties
Relay_AuthenticateThirdPartyCameraWSResponse
object
Response object for authenticating a third-party camera with RTSP URL.
5 properties
Relay_GetFullNVRStateWSRequest
object
Request object for getting detailed information about the state of a specified NVR.
2 properties
Relay_PTZMoveWSResponse
object
Response object for moving a PTZ camera.
3 properties
Relay_AssignThirdPartyCameraToRelayCameraWSRequest
object
Request object for assigning a third-party camera to a relay camera.
4 properties
Relay_AddThirdPartyCameraViaOnvifWSRequest
object
Add a third-party camera via ONVIF from an IP address and credentials.
8 properties
Relay_DeleteThirdPartyCameraDiscoveryWSRequest
object
Request object for deleting a third-party camera discovery.
1 property
Relay_UpdateFirmwareWSStatus
string
Status enumeration for firmware update web service responses.
RtspEndpoint
object
7 properties
Relay_GetAssignedThirdPartyCamerasWSRequest
object
Request object for getting third-party cameras assigned to a specific NVR.
1 property
WebResponseStatusEnum
string
Status of the unregister operation
Relay_NVRExternalType
object
External NVR type.
28 properties
Relay_ManualDiscoverThirdPartyCameraWSResponse
object
Response object for manually discovering a third-party camera with RTSP URL.
5 properties
DeviceHealthStatusDetailsEnum
string
Relay_DeleteThirdPartyCameraPasswordWSRequest
object
Request object for deleting a third-party camera password.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rhombus-systems-relay-webservice-api-openapi.yml Raw ↑

Other APIs Rhombus Systems publishes across the network.

Rhombus Console WebSocket API
AE Profile APIs.io
Rhombus Systems Access Control Integrations Webservice API
AE Profile APIs.io
Rhombus Systems Access Control Webservice API
AE Profile APIs.io
Rhombus Systems Alarm Monitoring Keypad Webservice API
AE Profile APIs.io
Rhombus Systems Alert Monitoring Webservice API
AE Profile APIs.io
Rhombus Systems AudioGateway Webservice API
AE Profile APIs.io
Rhombus Systems AudioPlayback Webservice API
AE Profile APIs.io
Rhombus Systems Badge Reader Webservice API
AE Profile APIs.io
Rhombus Systems BLE Webservice API
AE Profile APIs.io
Rhombus Systems Button Webservice API
AE Profile APIs.io
Rhombus Systems Camera Webservice API
AE Profile APIs.io
Rhombus Systems ClaimKey Webservice API
AE Profile APIs.io
#Relay Webservice
← Back to R APIs
API Details
ID
rhombus-systems:rhombus-systems-relay-webservice-api
Base URL
https://api2.rhombussystems.com/api
Docs
https://api-docs.rhombus.community/
Provider
Rhombus Systems
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=rhombus-systems-relay-webservice-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/rhombus-systems-relay-webservice-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Rhombus Systems Relay 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.