Overview
API Reference
Complete REST API reference covering 1,000+ Rhombus endpoints for cameras, access control, sensors, alarms, video streaming, and analytics.
The Rhombus API gives you programmatic access to the full Rhombus platform across 1,000+ endpoints. Every endpoint you see here is the same one that powers the Rhombus web console and mobile apps. If you can do it in the Rhombus UI, you can do it through the API.
Authentication
Every request carries a credential in headers. With an API key, send x-auth-scheme: api-token and the key in x-auth-apikey; with an OAuth access token, send Authorization: Bearer <token>. Each operation's page lists x-auth-scheme and x-auth-org:
| Header | When | Value |
|---|---|---|
x-auth-scheme | Every request, except that it's optional with Authorization: | One of seven schemes: api-token (API key), api (certificate API key), api-oauth-token (OAuth access token), federated-token (federated token), and the partner aliases partner-api-token, partner-api and partner-api-oauth-token |
x-auth-apikey | API keys and certificate API keys | Your API key from the Rhombus Console |
Authorization | OAuth access tokens | Bearer . A Bearer header with no x-auth-scheme is read as an OAuth access token (Sign in with Rhombus) |
x-auth-access-token | OAuth access tokens, as an alternative to Authorization | The access token, with x-auth-scheme: |
x-auth-ft | Federated tokens | The token, with x-auth-scheme: (Federated tokens) |
x-auth-org | Optional on every operation, for partner credentials | The UUID of the client organization to act in. A header only; a blank value counts as absent (Partner API Calls) |
curl -X POST https://api2.rhombussystems.com/api/org/getOrgV2 \
-H "x-auth-scheme: api-token" \
-H "x-auth-apikey: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'import requests
response = requests.post(
"https://api2.rhombussystems.com/api/org/getOrgV2",
headers={
"x-auth-scheme": "api-token",
"x-auth-apikey": "YOUR_API_KEY",
"Content-Type": "application/json",
},
json={},
)
print(response.json())curl -X POST https://api2.rhombussystems.com/api/org/getOrgV2 \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'An OAuth access token also needs the scope the operation requires; each operation's page shows it. See Authentication for which credential to use where.
Base URL
All API requests are made to one of two base URLs depending on the type of operation. Each has a US and an EU variant — use the one that matches your organization's region:
| Purpose | US | EU |
|---|---|---|
| All API endpoints (device management, configuration, events, users, etc.) | https://api2.rhombussystems.com | https://api2.eu.rhombussystems.com |
| Media and streaming operations (video clips, live streams, thumbnails) | https://media.rhombussystems.com | https://media.eu.rhombussystems.com |
API keys are region-bound — a key generated in one region's console returns 401 with errorCode INVALID_CREDENTIAL against the other region's endpoints. See API Regions (US & EU).
Common patterns
- Requests are POST with a JSON body — almost every endpoint takes a
POSTwith a JSON body, even read operations. The exceptions: OAuth authorization (GET /api/oauth/authorize), and file uploads such as/api/upload/..., which takemultipart/form-data. - Responses are JSON — except file downloads: several
/api/export/...endpoints return CSV (/api/export/uptimereturns a ZIP archive), and/api/video/getLiveImagereturns a JPEG image. Each endpoint's page shows its response type. - Empty body for simple queries — endpoints that do not require parameters still expect an empty JSON object (
{}). - Errors share one body —
msg,error(true),errorCode,errorMsg,status,timestampandtxid, plus anx-rhombus-txidresponse header. A401means the credential is missing or not valid; a403means it's valid but not permitted. See Errors.
Browse by category
Every operation, grouped by product. The sidebar lists them the same way.
- Robot35
- Partner38
This reference is generated from the production OpenAPI specification each time the site is built. Use Try it on any endpoint page to send a request with your API key.