Skip to main content
POST
Get or create device physical port config

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
ownerDeviceUuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

detectedInvalidPortConfigs
object[] | null
deviceComponents
object[] | null
devicePhysicalPortConfig
object
supportedAperioLockModels
enum<string>[] | null

What kind of lock this is. Stated because the protocol does not report it: Device Info gives a product class, which says what a device does rather than which model it is. A model the controller cannot drive is refused - it has to be V3 hardware, which is the only generation that reports a door mode, and it has to lock something.

Available options:
C100_V3,
E100_V3,
L100_V3,
H100_V3,
AU100_V3,
IN100_V3_MC,
G100_V3,
KL100_V3,
K100_V3_MC,
KS100_V3_MC,
ES100_V3_MC,
DL100_V3_MC,
DR100_V3_MC,
R100_V3_MC,
C100,
C100_V2SE,
E100,
E100_V2SE,
L100,
PROFILE_N2_MORTISE,
INCEPTA,
A100,
K100,
K100DI,
KS100,
M100,
R100
supportedSchlageApmFamilies
enum<string>[] | null

Which family of Schlage lock this is. Stated because the protocol cannot be asked: the OEM code reply has no address in it, so a reply cannot be attributed to one lock. It decides how the lock's status bits are read.

Available options:
AD_WIRED,
AD_WIRELESS,
ENGAGE,
RMRU
Last modified on October 5, 2026