Skip to main content
POST
PTZ status

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 getting PTZ status of a camera.

thirdPartyCameraUuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object containing PTZ status of a camera.

error
boolean | null
errorMsg
string | null
warningMsg
string | null
xpositionPermyriad
integer<int32> | null
int32

Current X-axis position in permyriad units

Example:

5000

ypositionPermyriad
integer<int32> | null
int32

Current Y-axis position in permyriad units

Example:

5000

zpositionPermyriad
integer<int32> | null
int32

Current Z-axis position in permyriad units

Example:

5000

Last modified on August 22, 2026