Skip to main content
POST
Manual discover camera

Authorizations

x-auth-apikey
string
header
required

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

x-auth-scheme
enum<string>
default:api-token
required

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

Request object for manually discovering a third-party camera with RTSP URL.

locationUuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

password
string | null

Password to access the RTSP URL. This field MUST be non-empty if trySavedCredentials is false

Example:

"password123"

rtspUrl
string | null

The RTSP URL of the third-party camera being manually added. This RTSP URL should reference a stream that provides H.264 encoded video

Example:

"rtsp://192.168.1.100:554/stream1"

trySavedCredentials
boolean | null

Whether the third-party credentials saved in the account should be used when trying to validate whether the provided RTSP URL is valid

Example:

false

username
string | null

Username to access the RTSP URL. This field MUST be non-empty if trySavedCredentials is false

Example:

"admin"

Response

200 - application/json

OK

Response object for manually discovering a third-party camera with RTSP URL.

error
boolean | null
errorMsg
string | null
result
object

The imported (discovered) third-party camera. This field is populated only if the RTSP URL specified in the import resulted in creation of a new discovery or an addition of a RTSP URL to an existing discovery. It is null, if the RTSP URL already existed or if the import was not successful.

rtspUrlStatus
enum<string>

Status of the RTSP URL validation

Available options:
UNKNOWN,
NOT_REACHABLE,
NOT_AUTHENTICATED,
NOT_SUPPORTED,
GOOD
warningMsg
string | null
Last modified on August 19, 2026