Skip to main content
POST
/
api
/
relay
/
authenticateThirdPartyCamera
Authenticate third party camera
curl --request POST \
  --url https://api2.rhombussystems.com/api/relay/authenticateThirdPartyCamera \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "password": "password123",
  "rtspUrl": "rtsp://192.168.1.100:554/stream1",
  "thirdPartyCameraMacAddress": "<string>",
  "trySavedCredentials": false,
  "username": "admin"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "result": {
    "codec": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "ipAddress": "<string>",
    "lastVisibleMs": {},
    "macAddress": "<string>",
    "manufacturer": "<string>",
    "model": "<string>",
    "name": "<string>",
    "onvifPassword": "<string>",
    "onvifProfileToken": "<string>",
    "onvifUsername": "<string>",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "password": "<string>",
    "rtspEndpoints": [
      {
        "audioSupported": true,
        "lastRtspUrlStatus": "UNKNOWN",
        "onvifProfileToken": "<string>",
        "rtspUrl": "<string>",
        "source": "USER",
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "updatedOn": "2023-11-07T05:31:56Z",
    "username": "<string>"
  },
  "rtspUrlStatus": "UNKNOWN",
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

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

​
locationUuid
string<RUUID> | null

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. This RTSP URL should reference a stream that provides H.264 encoded video

Example:

"rtsp://192.168.1.100:554/stream1"

​
thirdPartyCameraMacAddress
string | null

The MAC address of the third-party camera this request is operating on

​
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 authenticating 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> | null

Status of the RTSP URL validation

Available options:
UNKNOWN,
NOT_REACHABLE,
NOT_AUTHENTICATED,
NOT_SUPPORTED,
GOOD
​
warningMsg
string | null