Access Control Integrations

Create or update Honeywell NetBox integration (on-prem connector)

Activate or update the Honeywell NetBox integration from the on-prem side — the NetBox counterpart of createOrUpdateHoneywellOnGuardIntegration. Called by the Rhombus NetBox connector, which discovers portals via the NetBox GetPortals API and owns the door inventory; the console owns camera/location assignments. First activation (blank rhombusToken, no existing integration) generates the webhook token; re-calls merge the door map by portal key without overwriting console-made assignments, and keys absent from the request are preserved.

POST/api/integrations/accessControl/createOrUpdateHoneywellNetBoxIntegration

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the write scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Activate or update the Honeywell NetBox integration from the on-prem side — the NetBox counterpart of createOrUpdateHoneywellOnGuardIntegration. Called by the Rhombus NetBox connector, which discovers portals via the NetBox GetPortals API and owns the door inventory, while the console owns camera/location assignments. On first activation omit rhombusToken; the server generates the webhook token and returns it. On re-calls pass the token back; the reported door map is merged by portal key — new keys are added unmapped, existing keys get their display name refreshed, console-made camera/location/behavior assignments are never overwritten, and keys absent from the request (e.g. manually-added portals) are preserved.

baseUrlstring | nullbody

doorInfoMapobject | nullbody

Show child attributes

assignedCameraListstring<RUUID>[] | nullbody

clipDurationinteger<int32> | nullbody

doorNamestring | nullbody

leadingSecondsinteger<int32> | nullbody

locationUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | nullbody

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | nullbody

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

rhombusTokenstring | nullbody

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/integrations/accessControl/createOrUpdateHoneywellNetBoxIntegration' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "baseUrl": "<string>",
    "doorInfoMap": {
      "<key>": {
        "assignedCameraList": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "clipDuration": 0,
        "doorName": "<string>",
        "leadingSeconds": 0,
        "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "remoteUnlock": true,
        "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
      }
    },
    "rhombusToken": "<string>"
  }'

import requests

url = "https://api2.rhombussystems.com/api/integrations/accessControl/createOrUpdateHoneywellNetBoxIntegration"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "baseUrl": "<string>",
    "doorInfoMap": {
        "<key>": {
            "assignedCameraList": [
                "AAAAAAAAAAAAAAAAAAAAAA"
            ],
            "clipDuration": 0,
            "doorName": "<string>",
            "leadingSeconds": 0,
            "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "remoteUnlock": True,
            "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
        }
    },
    "rhombusToken": "<string>"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/integrations/accessControl/createOrUpdateHoneywellNetBoxIntegration', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "baseUrl": "<string>",
    "doorInfoMap": {
      "<key>": {
        "assignedCameraList": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "clipDuration": 0,
        "doorName": "<string>",
        "leadingSeconds": 0,
        "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "remoteUnlock": true,
        "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
      }
    },
    "rhombusToken": "<string>"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "baseUrl": "<string>",
              "doorInfoMap": {
                "<key>": {
                  "assignedCameraList": [
                    "AAAAAAAAAAAAAAAAAAAAAA"
                  ],
                  "clipDuration": 0,
                  "doorName": "<string>",
                  "leadingSeconds": 0,
                  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
                  "remoteUnlock": true,
                  "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
                }
              },
              "rhombusToken": "<string>"
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/integrations/accessControl/createOrUpdateHoneywellNetBoxIntegration"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>",
  "misconfiguredDoors": [
    "<string>"
  ],
  "rhombusToken": "<string>",
  "webhookUrl": "<string>"
}

Response

200 OK

application/json · object

Result of activating/updating the Honeywell NetBox integration from the on-prem side. Mirrors the OnGuard response shape, minus the pre-shared HMAC secret (the NetBox webhook is token-only).

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

misconfiguredDoorsstring[] | null

rhombusTokenstring | null

warningMsgstring | null

webhookUrlstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.