Skip to main content
POST
Escalate threat case to alarm

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 escalate a threat case to an alarm for alert monitoring.

uuid
string<RUUID> | null
required
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

authenticatePin
boolean | null

When true, the server authenticates the provided PIN against the threat case's zone and rejects the request if authentication fails. Expected from clients that cannot identify their caller such as alarm pads.

pin
string | null

Optional PIN used to authenticate this request and identify the initiating user or group. Only honored when authenticatePin is true; otherwise ignored.

Response

200 - application/json

OK

Response indicating the result of escalating a threat case to an alarm.

error
boolean | null
errorMsg
string | null
warningMsg
string | null
Last modified on October 5, 2026