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 '
{
"name": "<string>",
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"port": {
"boardNum": 123,
"portNum": 123
}
}
'import requests
url = "https://api2.rhombussystems.com/api/component/createIntegratedGenericButton"
payload = {
"name": "<string>",
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"port": {
"boardNum": 123,
"portNum": 123
}
}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
ownerDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
port: {boardNum: 123, portNum: 123}
})
};
fetch('https://api2.rhombussystems.com/api/component/createIntegratedGenericButton', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/component/createIntegratedGenericButton")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"ownerDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"port\": {\n \"boardNum\": 123,\n \"portNum\": 123\n }\n}")
.asString();{
"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"
}
}Component Webservice
Create a generic button component
Create a generic button component
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 '
{
"name": "<string>",
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"port": {
"boardNum": 123,
"portNum": 123
}
}
'import requests
url = "https://api2.rhombussystems.com/api/component/createIntegratedGenericButton"
payload = {
"name": "<string>",
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"port": {
"boardNum": 123,
"portNum": 123
}
}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
ownerDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
port: {boardNum: 123, portNum: 123}
})
};
fetch('https://api2.rhombussystems.com/api/component/createIntegratedGenericButton', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/component/createIntegratedGenericButton")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"ownerDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"port\": {\n \"boardNum\": 123,\n \"portNum\": 123\n }\n}")
.asString();{
"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
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
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
Response
200 - application/json
OK
Show child attributes
Show child attributes
Last modified on September 6, 2026