Skip to main content
POST
/
api
/
component
/
createIntegratedDoorRelay
Create a door relay component
curl --request POST \
  --url https://api2.rhombussystems.com/api/component/createIntegratedDoorRelay \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "name": "<string>",
  "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "port": {
    "boardNum": 123,
    "portNum": 123,
    "portType": "GPIO_OUTPUT"
  }
}
'
{
  "component": {
    "baseType": "reader",
    "createdAtMillis": 123,
    "name": "<string>",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "ownerHardwareType": "RASPBERRY_PI_3",
    "port": {
      "boardNum": 123,
      "portNum": 123,
      "portType": "GPIO_OUTPUT"
    },
    "portImmutable": true,
    "rateLimitingEnabled": true,
    "relayType": "integrated",
    "type": "RhombusOsdpDoorReader",
    "updatedAtMillis": 123,
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt

Use this file to discover all available pages before exploring further.

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

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

port
object

Response

200 - application/json

OK

component
object
Last modified on May 7, 2026