Skip to content

API Reference

Complete REST API reference covering 1,000+ Rhombus endpoints for cameras, access control, sensors, alarms, video streaming, and analytics.

On this page

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:

HeaderWhenValue
x-auth-schemeEvery request, except that it's optional with Authorization: BearerOne 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-apikeyAPI keys and certificate API keysYour API key from the Rhombus Console
AuthorizationOAuth access tokensBearer <access token>. A Bearer header with no x-auth-scheme is read as an OAuth access token (Sign in with Rhombus)
x-auth-access-tokenOAuth access tokens, as an alternative to AuthorizationThe access token, with x-auth-scheme: api-oauth-token
x-auth-ftFederated tokensThe token, with x-auth-scheme: federated-token (Federated tokens)
x-auth-orgOptional on every operation, for partner credentialsThe UUID of the client organization to act in. A header only; a blank value counts as absent (Partner API Calls)
bash
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 '{}'

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:

PurposeUSEU
All API endpoints (device management, configuration, events, users, etc.)https://api2.rhombussystems.comhttps://api2.eu.rhombussystems.com
Media and streaming operations (video clips, live streams, thumbnails)https://media.rhombussystems.comhttps://media.eu.rhombussystems.com
Info

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 POST with a JSON body, even read operations. The exceptions: OAuth authorization (GET /api/oauth/authorize), and file uploads such as /api/upload/..., which take multipart/form-data.
  • Responses are JSON — except file downloads: several /api/export/... endpoints return CSV (/api/export/uptime returns a ZIP archive), and /api/video/getLiveImage returns 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, timestamp and txid, plus an x-rhombus-txid response header. A 401 means the credential is missing or not valid; a 403 means it's valid but not permitted. See Errors.

Browse by category

Every operation, grouped by product. The sidebar lists them the same way.