Relay (third-party cameras)

Find discoveries with unassigned RTSP endpoints

Finds discoveries that have unassigned RTSP endpoints. Only discoveries containing at least one endpoint are returned.

POST/api/relay/findDiscoveriesWithUnassignedRtspEndpoints

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 read 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

Request object for finding discoveries with unassigned RTSP endpoints.

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/relay/findDiscoveriesWithUnassignedRtspEndpoints' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api2.rhombussystems.com/api/relay/findDiscoveriesWithUnassignedRtspEndpoints"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {}

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

const response = await fetch('https://api2.rhombussystems.com/api/relay/findDiscoveriesWithUnassignedRtspEndpoints', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
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 = """
            {}
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/relay/findDiscoveriesWithUnassignedRtspEndpoints"))
            .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

{
  "discoveries": [
    {
      "codec": "H.264",
      "ipAddress": "192.168.1.100",
      "macAddress": "<string>",
      "manufacturer": "Hikvision",
      "model": "DS-2CD2142FWD-I",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "unassignedRtspEndpoints": [
        {
          "lastRtspUrlStatus": "GOOD",
          "lensRole": "VISIBLE",
          "onvifProfileToken": "<string>",
          "password": "password123",
          "rtspUrl": "rtsp://192.168.1.100:554/stream1",
          "source": "USER",
          "username": "admin",
          "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      ]
    }
  ]
}

Response

200 OK

application/json · object

Response object containing discoveries with unassigned RTSP endpoints.

discoveriesobject[] | null

List of discoveries with unassigned RTSP endpoints

Show child attributes

codecstring | null

Codec of the discovered device

Example: "H.264"

ipAddressstring | null

IP address of the discovered device

Example: "192.168.1.100"

macAddressstring | null

MAC address of the discovered device

manufacturerstring | null

Manufacturer of the discovered device

Example: "Hikvision"

modelstring | null

Model of the discovered device

Example: "DS-2CD2142FWD-I"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

unassignedRtspEndpointsobject[] | null

List of unassigned RTSP endpoints that are available for assignment. Contains only endpoints with status GOOD and that are not currently assigned.

Show child attributes

lastRtspUrlStatusenum<string>

Status of the RTSP URL validation

Available options: UNKNOWN, NOT_REACHABLE, NOT_AUTHENTICATED, NOT_SUPPORTED, GOOD

lensRoleenum<string>

Available options: VISIBLE, THERMAL

onvifProfileTokenstring | null

ONVIF media profile token backing this endpoint (multi-sensor grouping); null when unknown

passwordstring | null

Password for RTSP authentication

Example: "password123"

rtspUrlstring | null

RTSP URL for the camera stream

Example: "rtsp://192.168.1.100:554/stream1"

sourceenum<string>

Available options: USER, ONVIF

usernamestring | null

Username for RTSP authentication

Example: "admin"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

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.