Skip to main content
POST
Register a Rhombus reader that a Door Controller has discovered

Authorizations

x-auth-apikey
string
header
required

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

Headers

x-auth-scheme
enum<string>
default:api-token
required

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.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json

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

boardNum
integer<int32> | null
int32

Board number for the reader connection

Example:

1

doorControllerUuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

portNum
integer<int32> | null
int32

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.

Last modified on August 7, 2026