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

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
mode
enum<string>

Optional button mode configuration

Available options:
PANIC,
PROGRAMMABLE,
DOORBELL,
NONE
name
string | null
ownerDeviceUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

port
object

Response

200 - application/json

OK

component
object