Skip to main content
POST
Get full audio gateway state

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 to get detailed information about the state of a specified audio gateway.

deviceUuid
string<DeviceFacetUuid> | null
DeviceFacetUuid

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

force
boolean | null

Force refresh of the device state

Example:

false

Response

200 - application/json

OK

Response containing detailed information about the state of a specified audio gateway.

error
boolean | null
errorMsg
string | null
fullAudioGatewayState
object

Detailed state information for the specified NVR

warningMsg
string | null
Last modified on August 3, 2026