Skip to main content
POST
/
api
/
component
/
getOrCreateDevicePhysicalPortConfig
Get or create device physical port config
curl --request POST \
  --url https://api2.rhombussystems.com/api/component/getOrCreateDevicePhysicalPortConfig \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "detectedInvalidPortConfigs": [
    {
      "boardNum": 123,
      "componentUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "portNum": 123
    }
  ],
  "deviceComponents": [
    {
      "allowCredsDuringUnlock": true,
      "createdAtMillis": 123,
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "disableCardReader": true,
      "disableKeypad": true,
      "disableWaveToUnlock": true,
      "hardwareUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "osdpAddress": 123,
      "otherReaderUnlockAudioFeedbackEnabled": true,
      "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "port": {
        "boardNum": 123,
        "portNum": 123
      },
      "portImmutable": true,
      "remoteUnlockAudioFeedbackEnabled": true,
      "serialNumber": "<string>",
      "updatedAtMillis": 123,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "devicePhysicalPortConfig": {
    "boardMap": {},
    "createdAtMillis": 123,
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "updatedAtMillis": 123
  }
}

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

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

​
detectedInvalidPortConfigs
object[] | null
​
deviceComponents
object[] | null
​
devicePhysicalPortConfig
object
Last modified on June 6, 2026