Relay Webservice

Authenticate third party camera

Authenticate a third party camera, effectively validating the credentials specified to be used for it.

post/api/relay/authenticateThirdPartyCamera

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/relay/authenticateThirdPartyCamera
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

passwordstring nullable

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

rtspUrlstring nullable

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

thirdPartyCameraMacAddressstring nullable

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

trySavedCredentialsboolean nullable

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

usernamestring nullable

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

Example request

{
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "password": "password123",
  "rtspUrl": "rtsp://192.168.1.100:554/stream1",
  "username": "admin"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
rtspUrlStatus'UNKNOWN' | 'NOT_REACHABLE' | 'NOT_AUTHENTICATED' | 'NOT_SUPPORTED' | 'GOOD'

Status of the RTSP URL validation

warningMsgstring nullable

Example response

{
  "result": {
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "rtspEndpoints": [
      {
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.