🚧 The Rhombus Developer Documentation is currently in beta. For the official documentation, please visit docs.rhombus.com.
Overview
Access Control
- POSTAdd users to access control group
- POSTAssign access control credential
- POSTCreate an HID Corp1000 Standard 35 bit credential
- POSTCreate an HID Corp1000 Standard 48 bit credential
- POSTCreate access control credential by hex value and type
- POSTCreate access control group
- POSTCreate access grant
- POSTCreate access revocation
- POSTCreate Rhombus Secure CSN credential
- POSTCreate standard CSN credential
- POSTCreate 64-bit raw Wiegand credential
- POSTCreate Wiegand credentialdeprecated
- POSTCreate D10202 Wiegand credential
- POSTCreate H10301 Wiegand credential
- POSTCreate H10304 Wiegand credential
- POSTDelete access control credential
- POSTDelete access control group
- POSTDelete location access grant
- POSTDelete location access revocation
- POSTDelete unassigned access control credential
- POSTFind access control credentials by org
- POSTFind access control credentials by user
- POSTFind access control credentials by users
- POSTFind access control group by exact name
- POSTFind access control group memberships by user
- POSTFind access control groups by name prefix
- POSTFind access control groups by org
- POSTFind access control groups by user membership
- POSTFind all users for access control group
- POSTFind credential history by credential hex value
- POSTFind credential history by credential value
- POSTFind credential history by user
- POSTFind location access grants by access controlled door
- POSTFind location access grants by access controlled elevator landing
- POSTFind location access grants by door label
- POSTFind location access grants by group
- POSTFind location access grants by location
- POSTFind location access grants by location and user
- POSTFind location access grants by org
- POSTFind location access grants by user
- POSTFind location access revocations by access controlled door
- POSTFind location access revocations by access controlled elevator landing
- POSTFind location access revocations by door label
- POSTFind location access revocations by group
- POSTFind location access revocations by org
- POSTFind location access revocations by user
- POSTGet location access grant
- POSTGet location access revocation
- POSTGet Rhombus Secure CSN credential details
- POSTGet standard CSN credential details
- POSTRemove users from access control group
- POSTRevoke access control credential
- POSTSuspend access control credential
- POSTUnlock access controlled door
- POSTUnsuspend access control credential
- POSTUpdate access control group
- POSTUpdate access grant
- POSTUpdate access revocation
- POSTUpdate Rhombus Secure CSN credential
- POSTUpdate Rhombus Secure mobile credential
- POSTUpdate standard CSN credential
- POSTUpdate Wiegand credential
Lockdown Plan
- POSTActivate lockdown for the specified location
- POSTCreate location lockdown plan
- POSTCreate lockdown rule for location
- POSTDeactivate lockdown for the specified location
- POSTDelete location lockdown state
- POSTDelete lockdown plan
- POSTDelete lockdown rule for location
- POSTDisable test mode of lockdown for the specified location
- POSTEnable test mode of lockdown for the specified location
- POSTFind location lockdown events
- POSTFind location lockdown states
- POSTFind lockdown plans in the org
- POSTFind lockdown plans for the specified location
- POSTGet lockdown plan
- POSTGet lockdown rules for location
- POSTGet or create location lockdown state
- POSTUpdate location lockdown plan
Alert Monitoring
- POSTCancel threat case
- POSTCreate custom PIN for location
- POSTCreate PIN for location
- POSTDelete PIN for location
- POSTDisable monitoring for location
- POSTDismiss threat case
- POSTEnable monitoring for location
- POSTEscalate threat case to alarm
- POSTGet alert monitoring settings for location
- POSTGet location status
- POSTGet organization status
AudioGateway
- POSTDelete audio gateway
- POSTGet audio seek points
- POSTGet audio gateway config
- POSTGet full audio gateway state
- POSTGet media URIs for audio gateway
- POSTGet minimal audio gateway state list
- POSTGet audio gateway presence windows
- POSTGet audio gateway uptime windows
- POSTUpdate audio gateway config
- POSTUpdate audio gateway details
AudioPlayback
Badge Reader
Button
Camera
- POSTCalibrate floorplan projection
- POSTCreate custom footage seekpoints
- POSTCreate footage bounding boxes
- POSTCreate protected shared live video stream
- POSTCreate protected shared video wall
- POSTCreate camera raw HTTP stream
- POSTCreate shared live video stream
- POSTCreate shared video wall
- POSTCreate video wall
- POSTDelete camera
- POSTDelete custom footage seekpoints
- POSTDelete camera raw HTTP stream
- POSTDelete shared live video stream
- POSTDelete shared video wall
- POSTDelete video wall
- POSTErase camera
- POSTFind all camera raw HTTP streams
- POSTFind all shared live video streams
- POSTFind camera shared live video streams
- POSTFind shared video walls
- POSTGenerate batch registration info
- POSTGenerate WiFi change authorization token
- POSTGet batch registration usage
- POSTGet camera AI thresholds
- POSTGet cloud archived media info
- POSTGet cloud archiving config
- POSTGet camera configdeprecated
- POSTGet current camera statedeprecated
- POSTGet custom footage seekpoints V2
- POSTGet camera details
- POSTGet footage bounding boxes
- POSTGet footage bounding boxes for multiple cameras
- POSTGet footage seekpoints for multiple cameras
- POSTGet footage seekpoints V2
- POSTGet full camera state
- POSTGet camera media URIs
- POSTGet minimal camera location map
- POSTGet minimal camera state list
- POSTGet minimal camera listdeprecated
- POSTGet camera offline LAN streaming info
- POSTGet camera presence windows
- POSTGet camera raw HTTP streams
- POSTGet storage recovery file
- POSTGet camera uptime windows
- POSTGet video walls
- POSTReboot camera
- POSTPost apicamerarevertcamerasettingstodefaults
- POSTPost apicamerarevertdayimagesettingstodefaults
- POSTPost apicamerarevertnightimagesettingstodefaults
- POSTPost apicamerareverttodefaults
- POSTUpdate camera AI thresholds
- POSTUpdate camera line crossing thresholds
- POSTUpdate camera configdeprecated
- POSTUpdate camera detailsdeprecated
- POSTUpdate camera details bulk V2
- POSTUpdate camera details V2
- POSTUpdate camera firmware
- POSTUpdate video walls
- POSTUpdate camera WiFi
Climate
- POSTDelete environmental gateway
- POSTGet climate events for environmental sensor
- POSTGet climate presence windows
- POSTGet climate sensor config
- POSTGet environmental gateway shadows
- POSTGet events for environmental gateway
- POSTGet minimal climate state list
- POSTGet minimal environmental gateway states
- POSTGet minimal state events for environmental gateway
- POSTReboot environmental gateway
- POSTUpdate climate sensor details
- POSTUpdate environmental gateway details
Component
- POSTCreate a label that can be assigned to an access controlled door
- POSTCreate an access controlled door
- POSTCreate custom activity seekpoints for a specified access controlled door
- POSTCreate a door position indicator component
- POSTCreate a door relay component
- POSTCreate a generic button component
- POSTCreate a generic input component
- POSTCreate a generic relay component
- POSTCreate a request to exit component
- POSTCreate a third party OSDP Reader component
- POSTCreate a Rhombus OSDP Reader component
- POSTCreate a third party Wiegand Reader component
- POSTDelete the specified access controlled door
- POSTDelete a component
- POSTDelete all components owned by the specified device
- POSTFind access controlled door shadows within the org
- POSTFind access controlled door shadows within the specified location
- POSTFind access controlled doors within the org
- POSTFind access controlled doors within the specified location
- POSTFind access controlled doors for the specified owner device
- POSTRetrieve all component shadows for the specified component uuids
- POSTRetrieve all component events relevant to the specified AccessControlledDoor
- POSTRetrieve all component events relevant to the specified api token
- POSTRetrieve all component events relevant to the specified component
- POSTRetrieve all component events relevant to the specified correlation id
- POSTRetrieve all component events relevant to the specified credential hex value
- POSTRetrieve all component events relevant to the specified credential uuid
- POSTRetrieve all component events relevant to the specified credential value
- POSTRetrieve all component events relevant to the specified location
- POSTRetrieve all component events relevant to the specified owner device (deprecated)deprecated
- POSTRetrieve all component events relevant to the specified support authority
- POSTRetrieve all component events relevant to the specified User
- POSTRetrieve all component events relevant to the specified Video Intercom and optional AccessControlledDoor
- POSTFind component seekpoints by access controlled door
- POSTFind component seekpoints by access controlled doors
- POSTFind component seekpoints by component
- POSTFind component seekpoints by location
- POSTFind component seekpoints by owner device
- POSTFind component seekpoints by user
- POSTRetrieve component shadows by the specified owner device uuid
- POSTRetrieve a list of components owned by a Rhombus device
- POSTFind minimal state access controlled doors within the org
- POSTFind minimal state access controlled doors within the specified location
- POSTRetrieve all component events relevant to the specified AccessControlledDoor
- POSTGet all access controlled door labels for the organization
- POSTGet or create device physical port config
- POSTRemove a label to an access controlled door
- POSTUpdates an access controlled door
- POSTUpdate a door position indicator component
- POSTUpdate a door relay component
- POSTUpdate a generic button component
- POSTUpdate a generic input component
- POSTUpdate a generic relay component
- POSTUpdate a generic relay component's steady state
- POSTActivate a generic relay for a brief period
- POSTUpdate a request to exit component
- POSTUpdate a third party OSDP Reader component
- POSTUpdate a Rhombus OSDP Reader component
- POSTUpdate a third party Wiegand Reader component
Elevator
- POSTCreate a label that can be assigned to an access controlled elevator landing
- POSTFind access controlled elevator landing shadows within the org
- POSTFind access controlled elevator landing shadows within the specified location
- POSTFind access controlled elevators landings within the specified location
- POSTGet all access controlled elevator landing labels for the organization
- POSTRemove a label to an access controlled elevator landing
Customer
User
- POSTUpdate notification settings for user
- POSTAssign email to user
- POSTCreate user for organization
- POSTDelete user
- POSTGet partner users in organization
- POSTGet users in organization
- POSTUpdate partner user details
- POSTUpdate partner user notification settings
- POSTUpdate Rhombus key settings for user
- POSTUpdate user detailsdeprecated
- POSTUpdate user notification settings
- POSTUpdate user details selectively
Developer
Door
Doorbell Camera
- POSTGenerate the homography to project detections onto a floorplan
- POSTCreate rule for a doorbell camera
- POSTShare an live video stream for a doorbell camera
- POSTRemove the doorbell camera from the organization
- POSTDelete rule for a doorbell camera
- POSTRetrieve all component events relevant to the specified Doorbell Camera
- POSTRetrieve all component seekpoints relevant to the specified Doorbell Camera
- POSTGet list of all shared live streams for doorbell camera
- POSTGet rules for all doorbell cameras in an org
- POSTGet all rules for a doorbell camera
Door Controller
Event
- POSTShare multiple clips in a single page
- POSTDelete alert monitoring threat case
- POSTDelete alert monitoring threat case by status
- POSTDelete all types of saved clips (splices in progress, completed splices, saved alerts)
- POSTDelete a shared clip page
- POSTDismiss all policy alerts for each specified device(s)
- POSTDismiss all policy alerts in organization
- POSTDismiss a policy alert
- POSTDismiss multiple policy alerts
- POSTGet alert monitoring threat case
- POSTGet alert monitoring threat cases
- POSTGet a specified saved clip with current progress
- POSTGet list of saved clips in organization, with current progress
- POSTGet list of expiring saved clips in organization
- POSTGet motion data for specified camera
- POSTGet aggregated motion heatmap for specified time period and camera
- POSTGet information about a policy alert
- POSTGet count of policy alerts
- POSTGet detailed information about policy alert, including seekpoints and bounding boxes
- POSTGet recent policy alerts for device, grouped by time
- POSTGet recent policy alerts for a location, grouped by time
- POSTGet recent policy alerts for organization, grouped by timedeprecated
- POSTGet information about a policy alertdeprecated
- POSTGet recent policy alerts for organization
- POSTGet recent policy alerts for organizationdeprecated
- POSTGet a count of saved clips in an organization
- POSTGet detailed information about a saved clip, including seekpoints and bounding boxes
- POSTUse /getSavedClipsV2 insteaddeprecated
- POSTGet list of saved clips matching the external transaction id
- POSTGet list of saved clips in organization
- POSTGet detailed information about a shared clip page, including seekpoints and bounding boxes
- POSTGet list of shared clip pages in organization
- POSTGet spliced clips in progressdeprecated
- POSTGet list of unhealthy devices in organization
- POSTMute notifications from a device for specified number of seconds
- POSTReport a bad policy event (AI false positive) and send information for feedback
- POSTSave a policy alert as a saved clip
- POSTSearch motion grid for motion events occuring in specified grid cells
- POSTSearch motion grid for motion events occuring in specified grid cells
- POSTUnsave policy alert and remove associated saved clipdeprecated
- POSTSelectively update a saved clip
- POSTUpdate shared clip page title, description, password, or expiration time
Event Search
Export
- POSTDownload audit log
- POSTDownload climate event log
- POSTDownload count report
- POSTDownload diagnostic log
- POSTDownload door event log
- POSTDownload environmental gateway event log
- POSTDownload device inventory
- POSTDownload motion event log for motion sensors
- POSTDownload people count report
- POSTDownload people event log
- POSTDownload proximity tag event log
- POSTDownload proximity tag event log
- POSTDownload device uptime reports
- POSTDownload org users
- POSTDownload vehicle event logdeprecated
- POSTDownload vehicle event log
Face Recognition Event
Face Recognition Matchmaker
- POSTCreate face matchmaker from sighting
- POSTDelete face matchmaker
- POSTFind face matchmakers by org
- POSTFind face matchmakers by person
- POSTFind face upload metadata by transaction
- POSTGet face matching configuration
- POSTGet face matchmaker
- POSTUpdate face matching configuration
- POSTUpload face matchmakers
Face Recognition Person
Feature
Help
IoT Integrations
Access Control Integrations
- POSTDelete AMT badge integration
- POSTDelete Avigilon Alta badge integration V2
- POSTDelete Boulevard integration
- POSTDelete Brivo badge integration
- POSTDelete Brivo badge integration V2
- POSTDelete ButterflyMX badge integration
- POSTDelete ButterflyMX badge integration V2
- POSTDelete Genea badge integration
- POSTDelete Genea badge integration V2
- POSTDelete Inner Range integration
- POSTDelete Kisi badge integrationdeprecated
- POSTDelete Kisi badge integration V2
- POSTDelete Openpath badge integration
- POSTDelete Opentech Alliance integration
- POSTDelete Opentech Alliance integration V2
- POSTDelete ProDataKey badge integration
- POSTDelete ProDataKey badge integration V2
- POSTDelete PlaceOs badge integration
- POSTDelete PlaceOs badge integration V2
- POSTGet list of AMT readers to assign cameras
- POSTGet Avigilon Alta integration
- POSTGet Boulevard integration
- POSTGet list of available Brivo doors to assign cameras
- POSTGet list of available Brivo doors to assign cameras V2
- POSTGet list of available Brivo doors to assign cameras V3
- POSTGet Brivo badge integration V2
- POSTGet ButterflyMX badge integration V2
- POSTGet list of available ButterflyMX panels to assign cameras
- POSTGet list of available ButterflyMX panels to assign cameras V2
- POSTGet list of Genea doors to assign cameras
- POSTGet Genea integration
- POSTGet Inner Range console settings
- POSTGet list of Inner Range doorsdeprecated
- POSTGet Inner Range integration
- POSTGet list of Kisi doors to assign camerasdeprecated
- POSTGet Kisi badge integrationdeprecated
- POSTGet Kisi badge integration V2
- POSTGet list of Kisi places to assign camerasdeprecated
- POSTGet list of Openpath doors to assign cameras
- POSTGet list of Openpath lockdown plans to trigger
- POSTGet list of Opentech Alliance facilities
- POSTGet list of Opentech Alliance facilities V2
- POSTGet Opentech Alliance integration V2
- POSTGet list of ProDataKey doors to assign cameras
- POSTGet ProDataKey badge integration
- POSTGet list of PlaceOs doors to assign cameras
- POSTGet PlaceOs integration V2
- POSTRevert Openpath lockdown plan
- POSTTest Boulevard API connection
- POSTTrigger Openpath lockdown plan
- POSTUnlock Brivo door
- POSTUnlock Brivo door V2
- POSTUnlock Genea door
- POSTUnlock Inner Range door
- POSTUnlock Kisi door
- POSTUnlock Openpath door
- POSTUnlock Opentech Alliance door
- POSTUnlock Opentech Alliance door V2
- POSTUnlock ProDataKey door
- POSTUnlock PlaceOs door
- POSTUpdate AMT badge integration
- POSTUpdate Avigilon Alta badge integration V2
- POSTUpdate Boulevard integration
- POSTUpdate Brivo badge integration
- POSTUpdate Brivo badge integration V2
- POSTUpdate ButterflyMX badge integration
- POSTUpdate ButterflyMX badge integration V2
- POSTUpdate Genea badge integration
- POSTUpdate Genea badge integration V2
- POSTUpdate Inner Range integration
- POSTUpdate Kisi badge integrationdeprecated
- POSTUpdate Kisi badge integration V2
- POSTUpdate Openpath badge integration
- POSTUpdate Opentech Alliance integration
- POSTUpdate Opentech Alliance integration V2
- POSTUpdate ProDataKey badge integration
- POSTUpdate ProDataKey badge integration V2
- POSTUpdate PlaceOs badge integration
- POSTUpdate PlaceOs badge integration V2
Integrations
- POSTDelete AMT Integrationdeprecated
- POSTDelete Device Integrationdeprecated
- POSTDelete Mattermost Integrationdeprecated
- POSTDelete OpenAI Integrationdeprecated
- POSTDelete Webhook Integrationdeprecated
- POSTDelete Webhook Integration V2deprecated
- POSTGet AMT Readersdeprecated
- POSTGet API Token Applicationsdeprecated
- POSTGet API Tokensdeprecated
- POSTGet Calendly Event Detailsdeprecated
- POSTGet Device Integrationdeprecated
- POSTGet OpenAI Integrationdeprecated
- POSTGet OpenAI Modelsdeprecated
- POSTGet Organization Integrationsdeprecated
- POSTGet Organization Integrations V2deprecated
- POSTGet Webhook Integrationdeprecated
- POSTRevoke API Tokendeprecated
- POSTSubmit API Token Applicationdeprecated
- POSTSubscribe Zapier Webhookdeprecated
- POSTUnsubscribe Zapier Webhookdeprecated
- POSTUpdate AMT Integrationdeprecated
- POSTUpdate Device Integrationdeprecated
- POSTUpdate Mattermost Integrationdeprecated
- POSTUpdate Noonlight Settingsdeprecated
- POSTUpdate OpenAI Integrationdeprecated
- POSTUpdate Webhook Integrationdeprecated
- POSTUpdate Webhook Integration V2deprecated
- POSTValidate API Token
- POSTGet Envoy deliveries
- POSTGet Envoy employees
- POSTGet Envoy locations
- POSTGet Envoy visitors
Incident Management Integrations
- POSTDelete Dice Integration
- POSTDelete Email Integration
- POSTDelete Informacast Integration
- POSTDelete Lumeo Integration
- POSTDelete Mattermost Integration
- POSTDelete Microsoft Teams Integration V2
- POSTDelete Microsoft Teams User
- POSTDelete OpenAI Integration
- POSTDelete PagerDuty Integration
- POSTDelete ServiceNow Integration
- POSTDelete Slack Integration V2
- POSTGet Dice Integration
- POSTGet Informacast Integration
- POSTGet Informacast Scenarios
- POSTGet Lumeo Integration
- POSTGet Microsoft Teams Integration
- POSTGet Microsoft Users Joined Teams
- POSTGet OpenAI Integration
- POSTGet OpenAI Models
- POSTInstall Microsoft Teams Bot For Team
- POSTInstall Microsoft Teams Bot For User
- POSTUninstall Microsoft Teams Bot For Team
- POSTUninstall Microsoft Teams Bot For User
- POSTUpdate Dice Integration
- POSTUpdate Email Integration
- POSTUpdate Informacast Integration
- POSTUpdate Lumeo Integration
- POSTUpdate Mattermost Integration
- POSTUpdate Microsoft Teams Integration V2
- POSTUpdate OpenAI Integration
- POSTUpdate PagerDuty Integration
- POSTUpdate ServiceNow Integration
- POSTUpdate Slack Integration
- POSTUpdate Slack Integration V2
Org Integrations
Service Management Integrations
- POSTCreate Envoy invite
- POSTDelete Envoy integrationdeprecated
- POSTDelete Envoy integration V2
- POSTDelete Toast integrationdeprecated
- POSTDelete Toast integration V2
- POSTGet Calendly event details
- POSTGet Envoy integration
- POSTGet Toast integration
- POSTGet Toast service areas
- POSTInitiate Envoy OAuth
- POSTUpdate Envoy integrationdeprecated
- POSTUpdate Envoy integration V2
- POSTUpdate Toast integrationdeprecated
- POSTUpdate Toast integration V2
Storage Integrations
- POSTDelete AWS integration
- POSTDelete Box integration
- POSTDelete Dropbox integration
- POSTDelete Google integrationdeprecated
- POSTDelete Google integration V2
- POSTDelete Office365 integration
- POSTGet Google integration
- POSTInitiate Dropbox OAuth
- POSTInitiate Google OAuth
- POSTInitiate Office365 OAuth
- POSTRefresh Google access token
- POSTRevoke Google Drive access
- POSTUpdate AWS integration
- POSTUpdate Box integration
- POSTUpdate Dropbox integration
- POSTUpdate Google integrationdeprecated
- POSTUpdate Google integration V2
- POSTUpdate Office365 integration
Webhook Integrations
Internal
Alarm Monitoring Keypad
Guest Management Kiosk
License
- POSTAssign ACU door license
- POSTAssign alert monitoring license
- POSTAssign device license
- POSTAssign license
- POSTGet ACU door licenses
- POSTGet ACU door licenses for client org
- POSTGet alert monitoring licenses
- POSTGet alert monitoring licenses for client org
- POSTGet device licenses
- POSTGet device licenses for client org
- POSTGet licenses
- POSTGet licenses for client org
Location
- POSTAdd location label
- POSTCreate location
- POSTDelete location
- POSTGeocode address
- POSTGet location
- POSTGet location labels for org
- POSTGet locations
- POSTGet locations by labels
- POSTGet locations by geo
- POSTGet locations by hierarchy key
- POSTRemove location label
- POSTSelective update location
- POSTUpdate location
Media Device
OAuth
Occupancy
Org
- POSTClaim activation token
- POSTClaim shipment registration token
- POSTCreate pending registration
- POSTDelete cloud archiving config
- POSTDelete keypad logo
- POSTDelete rhombus key logo
- POSTFind all hardware with pending registration
- POSTFind hardware available for pending registration
- POSTFind if team name available
- POSTFind SCIM settings for organization
- POSTGenerate federated session token
- POSTGet client organization details
- POSTGet cloud archiving configs
- POSTGet organization features
- POSTGet organization detailsdeprecated
- POSTGet organization integrationsdeprecated
- POSTGet organization notification templatedeprecated
- POSTGet organization notification template V2
- POSTGet organization details V2
- POSTGet SAML settingsdeprecated
- POSTGet SAML settings V2
- POSTGet SCIM display info
- POSTGet temporary org token
- POSTPeek shipment registration token
- POSTRemove pending registration
- POSTRevoke SCIM access for organization
- POSTSetup SCIM access for organization
- POSTUpdate AI training settings
- POSTUpdate cloud archiving config
- POSTUpdate firmware settings
- POSTUpdate general settings
- POSTUpdate MFA settings
- POSTUpdate organization detailsdeprecated
- POSTUpdate organization AI audio analysis policy
- POSTUpdate organization audio recording policy
- POSTUpdate organization's LLM usage opt-in policy
- POSTUpdate organization notification templatedeprecated
- POSTUpdate organization notification template V2
- POSTUpdate pending registration
- POSTUpdate SAML settingsdeprecated
- POSTUpdate SAML settings V2
- POSTUpdate SCIM settings for organization
Partner
- POSTCreate partner client
- POSTCustomize client
- POSTCustomize client device
- POSTDelete partner client
- POSTGet API token applicationsdeprecated
- POSTGet API tokens
- POSTGet client devices
- POSTGet client status map
- POSTGet client summary info
- POSTGet partner clients
- POSTGet partner clients V2
- POSTGet device licenses for organizationdeprecated
- POSTGet licenses for organizationdeprecated
- POSTGet list of all client devices
- POSTGet list of available hardware
- POSTGet client shipments
- POSTReassign device organization
- POSTRegister camera to client
- POSTRegister deal
- POSTRevoke API token
- POSTUpdate send license expiration email
Permission
- POSTCreate partner permission group
- POSTCreate permission group
- POSTDelete partner permission group
- POSTDelete permission group
- POSTGet partner permission groups
- POSTGet permission groups
- POSTGet permissions for current partner
- POSTGet permissions for current user
- POSTUpdate partner permission group
- POSTUpdate permission group
Policy
- POSTCreate access controlled door policy
- POSTCreate audio policy
- POSTCreate camera policy
- POSTCreate climate policy
- POSTCreate door policy
- POSTCreate occupancy policy
- POSTCreate policy addendum for location
- POSTCreate policy addendums for devices
- POSTCreate proximity policy
- POSTCreate schedule
- POSTCreate video intercom policy
- POSTDelete access controlled door policy
- POSTDelete audio policy
- POSTDelete camera policy
- POSTDelete climate policy
- POSTDelete device policy addendums
- POSTDelete door policy
- POSTDelete location policy addendum
- POSTDelete occupancy policy
- POSTDelete policy pause setting for component composite
- POSTDelete policy pause setting for device
- POSTDelete policy pause setting for location
- POSTDelete proximity policy
- POSTDelete schedule
- POSTDelete video intercom policy
- POSTFind schedules
- POSTGet access controlled door policies
- POSTGet audio policies
- POSTGet camera policies
- POSTGet climate policies
- POSTGet door policies
- POSTGet occupancy policies
- POSTGet policies using schedule
- POSTGet policy addendums
- POSTGet policy pause settings
- POSTGet proximity policies
- POSTGet video intercom policies
- POSTPause alert policy for component composite
- POSTPause alert policy for device
- POSTPause alert policy for location
- POSTUpdate access controlled door policy
- POSTUpdate audio policy
- POSTUpdate camera policy
- POSTUpdate climate policy
- POSTUpdate door policy
- POSTUpdate occupancy policy
- POSTUpdate proximity policy
- POSTUpdate schedule
- POSTUpdate video intercom policy
Proximity
RapidSOS
Relay
- POSTAssign third party camera to NVR
- POSTAssign third party camera to relay camera
- POSTAuthenticate third party camera
- POSTCreate third party camera password
- POSTDelete third party camera discovery
- POSTDelete third party camera password
- POSTExecute third party camera discovery
- POSTFind discoveries with unassigned RTSP endpoints
- POSTGet assigned third party cameras
- POSTGet NVR details
- POSTGet full NVR state
- POSTGet minimal NVR state list
- POSTGet minimal third party camera state list
- POSTGet RTSP endpoints
- POSTGet third party camera passwords
- POSTGet uptime information for an NVR.
- POSTManual discover camera
- POSTPTZ move
- POSTPTZ status
- POSTReboot NVR
- POSTUnassign third party camera
- POSTUnregister NVR
- POSTUpdate NVR details V2
- POSTUpdate NVR firmware
Report
- POSTGet audit feed
- POSTGet batch threshold crossing count report
- POSTGet count reportdeprecated
- POSTGet count report V2
- POSTGet count reports
- POSTGet count reports for devices at location
- POSTGet custom events aggregation binary counts
- POSTGet custom events aggregation numeric counts
- POSTGet custom events report
- POSTGet diagnostic feed
- POSTGet integration diagnostic events
- POSTGet license plates by device
- POSTGet most recent people count events
- POSTGet occupancy counts
- POSTGet occupancy counts V2
- POSTGet proximity tag locations by date
- POSTGet running average
- POSTGet summary count report
- POSTGet threshold crossing count report for device
- POSTGet org wide batch threshold crossing count report
- POSTGet threshold crossing countsdeprecated
- POSTGet threshold crossing events
- POSTGet threshold crossing events for device
- POSTGet Toast events table
- POSTGet Toast events table all locations
- POSTReset running average
Rules
Rules Records
Scene Query
Schedule
- POSTCreate absolute schedule
- POSTCreate relative datetime intervals schedule
- POSTCreate relative schedule
- POSTCreate weekly schedule
- POSTDelete schedule
- POSTFind absolute schedule
- POSTFind relative datetime intervals schedule
- POSTFind relative schedule
- POSTFind weekly schedule
- POSTGet schedule data
- POSTGet schedule data V2
- POSTGet schedules
Search
Sensor
Upload
User Metadata
Vehicle
- POSTAdd vehicle label
- POSTAssociate events to vehicle
- POSTDelete vehicle
- POSTGet recent vehicle eventsdeprecated
- POSTGet recent vehicle events by locationdeprecated
- POSTGet recent vehicle events for vehicledeprecated
- POSTGet vehicle events
- POSTGet vehicle labels for organization
- POSTGet vehicles
- POSTRemove vehicle label
- POSTReport vehicle event
- POSTSave vehicle
Video
- POSTCancel splicedeprecated
- POSTCancel splice V2
- POSTCreate shared timelapse group
- POSTDelete shared timelapse group
- POSTDelete timelapse clips
- POSTGenerate timelapse clip
- POSTGet exact frame URI
- POSTGet max splice duration
- POSTGet shared timelapse groups
- POSTGet spliced clips in progress
- POSTGet timelapse clips
- POSTGet timelapse metadata
- POSTRetry splice
- POSTShare timelapse clipsdeprecated
- POSTSplicedeprecated
- POSTSplice frame
- POSTSplice V2deprecated
- POSTSplice V3
- POSTUpdate shared timelapse group
Validate API Token
curl --request POST \
--url https://api2.rhombussystems.com/api/integrations/validateToken \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>'{
"error": true,
"errorMsg": "<string>",
"warningMsg": "<string>"
}Validate API Token
Verifies an API token is still active
POST
/
api
/
integrations
/
validateToken
Validate API Token
curl --request POST \
--url https://api2.rhombussystems.com/api/integrations/validateToken \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>'{
"error": true,
"errorMsg": "<string>",
"warningMsg": "<string>"
}Authorizations
Your API key for Rhombus.
Headers
Authentication scheme indicator ("api-token").
Required string length:
9Was this page helpful?
⌘I