Skip to main content
POST
/
api
/
doorcontroller
/
registerDiscoveredRhombusReader
Register a Rhombus reader that a Door Controller has discovered
curl --request POST \
  --url https://api2.rhombussystems.com/api/doorcontroller/registerDiscoveredRhombusReader \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "boardNum": 1,
  "doorControllerUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "portNum": 0,
  "serialNumber": "RR-12345678"
}
'
{}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for registering a Rhombus reader discovered by a door controller.

boardNum
integer<int32> | null

Board number for the reader connection

Example:

1

doorControllerUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

portNum
integer<int32> | null

Port number for the reader connection

Example:

0

serialNumber
string | null

Serial number of the discovered Rhombus reader

Example:

"RR-12345678"

Response

200 - application/json

OK

Response object for registering a Rhombus reader discovered by a door controller.