Rhombus Systems Relay Webservice API

openapi: 3.2.0
info:
  contact:
    email: developer@rhombussystems.com
  description: 'This API is for use by Rhombus customers and partners.


    ## Authentication


    All requests require two headers:

    - `x-auth-scheme` — The authentication scheme identifier. Use `api-token` for standard API key auth, or `partner-api-token` for partner API auth.

    - `x-auth-apikey` — Your Rhombus API key.


    Example:

    ```

    POST /api/camera/getMinimalCameraStateList

    x-auth-scheme: api-token

    x-auth-apikey: YOUR_API_KEY

    Content-Type: application/json

    ```'
  title: Rhombus Relay Webservice API
  version: '1.0'
servers:
- description: Production Server
  url: https://api2.rhombussystems.com
security:
- ApiKeyAuth: []
tags:
- name: Relay Webservice
paths:
  /api/relay/addThirdPartyCameraViaOnvif:
    post:
      description: Probe a single camera by IP address over ONVIF, auto-derive its metadata, and (unless disabled) provision it — adding a camera from just an IP and credentials.
      operationId: addThirdPartyCameraViaOnvif
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_AddThirdPartyCameraViaOnvifWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_AddThirdPartyCameraViaOnvifWSResponse'
          description: OK
      summary: Add third party camera via ONVIF
      tags:
      - Relay Webservice
  /api/relay/assignThirdPartyCameraToNVR:
    post:
      description: Assign a third party camera to an NVR
      operationId: assignThirdPartyCameraToNVR
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_AssignThirdPartyCameraToNVRWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_AssignThirdPartyCameraToNVRWSResponse'
          description: OK
      summary: Assign third party camera to NVR
      tags:
      - Relay Webservice
  /api/relay/assignThirdPartyCameraToRelayCamera:
    post:
      description: Assign a third party camera to a relay Camera
      operationId: assignThirdPartyCameraToRelayCamera
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_AssignThirdPartyCameraToRelayCameraWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_AssignThirdPartyCameraToRelayCameraWSResponse'
          description: OK
      summary: Assign third party camera to relay camera
      tags:
      - Relay Webservice
  /api/relay/assignThirdPartyMultiFacetCameraToNVR:
    post:
      description: Assign a multi-sensor third party camera to an NVR as one camera with multiple video facets (gated on the multiFacetThirdPartyCameraEnabled org flag)
      operationId: assignThirdPartyMultiFacetCameraToNVR
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_AssignThirdPartyMultiFacetCameraToNVRWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_AssignThirdPartyMultiFacetCameraToNVRWSResponse'
          description: OK
      summary: Assign multi-facet third party camera to NVR
      tags:
      - Relay Webservice
  /api/relay/authenticateThirdPartyCamera:
    post:
      description: Authenticate a third party camera, effectively validating the credentials specified to be used for it.
      operationId: authenticateThirdPartyCamera
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_AuthenticateThirdPartyCameraWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_AuthenticateThirdPartyCameraWSResponse'
          description: OK
      summary: Authenticate third party camera
      tags:
      - Relay Webservice
  /api/relay/createThirdPartyCameraPassword:
    post:
      description: Create a third party camera password
      operationId: createThirdPartyCameraPassword
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_CreateThirdPartyCameraPasswordWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_CreateThirdPartyCameraPasswordWSResponse'
          description: OK
      summary: Create third party camera password
      tags:
      - Relay Webservice
  /api/relay/deleteThirdPartyCameraDiscovery:
    post:
      description: Delete third party camera discovery if it has no assignments.
      operationId: deleteThirdPartyCameraDiscovery
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_DeleteThirdPartyCameraDiscoveryWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_DeleteThirdPartyCameraDiscoveryWSResponse'
          description: OK
      summary: Delete third party camera discovery
      tags:
      - Relay Webservice
  /api/relay/deleteThirdPartyCameraPassword:
    post:
      description: Delete a third party camera password
      operationId: deleteThirdPartyCameraPassword
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_DeleteThirdPartyCameraPasswordWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_DeleteThirdPartyCameraPasswordWSResponse'
          description: OK
      summary: Delete third party camera password
      tags:
      - Relay Webservice
  /api/relay/executeThirdPartyCameraDiscovery:
    post:
      description: Trigger a discovery of cameras on the local LANs
      operationId: executeThirdPartyCameraDiscovery
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_ExecuteThirdPartyCameraDiscoveryWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_ExecuteThirdPartyCameraDiscoveryWSResponse'
          description: OK
      summary: Execute third party camera discovery
      tags:
      - Relay Webservice
  /api/relay/findDiscoveriesWithUnassignedRtspEndpoints:
    post:
      description: Finds discoveries that have unassigned RTSP endpoints. Only discoveries containing at least one endpoint are returned.
      operationId: findDiscoveriesWithUnassignedRtspEndpoints
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_FindDiscoveriesWithUnassignedRtspEndpointsWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_FindDiscoveriesWithUnassignedRtspEndpointsWSResponse'
          description: OK
      summary: Find discoveries with unassigned RTSP endpoints
      tags:
      - Relay Webservice
  /api/relay/getAssignedThirdPartyCameras:
    post:
      description: Get a list of the third party cameras assigned to an NVR
      operationId: getAssignedThirdPartyCameras
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_GetAssignedThirdPartyCamerasWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_GetAssignedThirdPartyCamerasWSResponse'
          description: OK
      summary: Get assigned third party cameras
      tags:
      - Relay Webservice
  /api/relay/getDetails:
    post:
      description: Get hardware details of multiple NVRs
      operationId: getNVRDetails
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_GetNVRDetailsWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_GetNVRDetailsWSResponse'
          description: OK
      summary: Get NVR details
      tags:
      - Relay Webservice
  /api/relay/getFullNVRState:
    post:
      description: Get detailed information about state of specified NVR
      operationId: getFullNVRState
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_GetFullNVRStateWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_GetFullNVRStateWSResponse'
          description: OK
      summary: Get full NVR state
      tags:
      - Relay Webservice
  /api/relay/getMinimalNVRStateList:
    post:
      description: Get basic state information about all NVRs in organization
      operationId: getMinimalNVRStateList
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_GetMinimalNVRStateListWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_GetMinimalNVRStateListWSResponse'
          description: OK
      summary: Get minimal NVR state list
      tags:
      - Relay Webservice
  /api/relay/getMinimalThirdPartyCameraStateList:
    post:
      description: Get basic state information about all third party cameras in the organization
      operationId: getMinimalThirdPartyCameraStateList
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_GetMinimalThirdPartyCameraStateListWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_GetMinimalThirdPartyCameraStateListWSResponse'
          description: OK
      summary: Get minimal third party camera state list
      tags:
      - Relay Webservice
  /api/relay/getRtspEndpoints:
    post:
      description: Gets rtsp endpoints for device with the specified mac address.
      operationId: getRtspEndpoints
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_GetRtspEndpointsWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_GetRtspEndpointsWSResponse'
          description: OK
      summary: Get RTSP endpoints
      tags:
      - Relay Webservice
  /api/relay/getThirdPartyCameraDiscoveryScanStatus:
    post:
      description: Returns the progress of the current/most-recent third-party camera discovery run in the org, so clients can show progress and distinguish not-started, in-progress, and complete (including complete-with-zero-cameras).
      operationId: getThirdPartyCameraDiscoveryScanStatus
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_GetThirdPartyCameraDiscoveryScanStatusWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_GetThirdPartyCameraDiscoveryScanStatusWSResponse'
          description: OK
      summary: Get third party camera discovery scan status
      tags:
      - Relay Webservice
  /api/relay/getThirdPartyCameraPasswords:
    post:
      description: Get a list of the third party camera passwords
      operationId: getThirdPartyCameraPasswords
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_GetThirdPartyCameraPasswordsWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_GetThirdPartyCameraPasswordsWSResponse'
          description: OK
      summary: Get third party camera passwords
      tags:
      - Relay Webservice
  /api/relay/getUptimeWindows:
    post:
      description: Get uptime information for an NVR.
      operationId: getRelayUptimeWindows
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Common_devices_GetUptimeWindowsWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common_devices_GetUptimeWindowsWSResponse'
          description: OK
      summary: Get uptime information for an NVR.
      tags:
      - Relay Webservice
  /api/relay/manualDiscoverCamera:
    post:
      description: Manually identify a camera on the network
      operationId: manualDiscoverCamera
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_ManualDiscoverThirdPartyCameraWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_ManualDiscoverThirdPartyCameraWSResponse'
          description: OK
      summary: Manual discover camera
      tags:
      - Relay Webservice
  /api/relay/ptzMove:
    post:
      description: Trigger a pan, tilt, or zoom
      operationId: ptzMove
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_PTZMoveWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_PTZMoveWSResponse'
          description: OK
      summary: PTZ move
      tags:
      - Relay Webservice
  /api/relay/ptzStatus:
    post:
      description: Returns ptz status
      operationId: ptz
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_PTZStatusWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_PTZStatusWSResponse'
          description: OK
      summary: PTZ status
      tags:
      - Relay Webservice
  /api/relay/reboot:
    post:
      description: Reboot an NVR
      operationId: rebootNVR
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_RebootNVRVWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_RebootNVRVWSResponse'
          description: OK
      summary: Reboot NVR
      tags:
      - Relay Webservice
  /api/relay/unassignThirdPartyCamera:
    post:
      description: Unassign a third party camera from an NVR
      operationId: unassignThirdPartyCamera
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_UnassignThirdPartyCameraWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_UnassignThirdPartyCameraWSResponse'
          description: OK
      summary: Unassign third party camera
      tags:
      - Relay Webservice
  /api/relay/unregister:
    post:
      description: Remove an NVR from organization
      operationId: unregisterNVR
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_UnregisterNVRWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_UnregisterNVRWSResponse'
          description: OK
      summary: Unregister NVR
      tags:
      - Relay Webservice
  /api/relay/updateDetailsV2:
    post:
      description: Update hardware details of NVR.
      operationId: updateNVRDetailsV2
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_UpdateNVRWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_UpdateNVRWSResponse'
          description: OK
      summary: Update NVR details V2
      tags:
      - Relay Webservice
  /api/relay/updateFirmware:
    post:
      description: Send command to update firmware to NVR
      operationId: updateNVRFirmware
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Relay_UpdateNVRFirmwareWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relay_UpdateNVRFirmwareWSResponse'
          description: OK
      summary: Update NVR firmware
      tags:
      - Relay Webservice
components:
  schemas:
    Relay_AssignThirdPartyCameraToNVRWSRequest:
      type: object
      description: Request object for assigning a third-party camera to an NVR.
      properties:
        discoveredCameraMacAddress:
          type:
          - string
          - 'null'
          description: MAC address of the discovered camera to assign
        locationUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example:

# --- truncated at 32 KB (105 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rhombus-systems/refs/heads/main/openapi/rhombus-systems-relay-webservice-api-openapi.yml