Save a policy alert as a saved clip

Save a policy alert as a saved clip

POST /api/event/savePolicyAlertV2

Save a policy alert as a saved clip

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/event/savePolicyAlertV2 \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "alertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "fisheyePresentationMap": {},
  "savedClipDescription": "Motion detected at main entrance",
  "savedClipTitle": "Security Incident - Motion Detected"
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

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 saving a policy alert as a clip.

alertUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

fisheyePresentationMap · object

Map of device UUIDs to dewarped view configurations for fisheye cameras

Show child attributes

savedClipDescription · string | null

Description for the saved clip

Example:

"Motion detected at main entrance"

savedClipTitle · string | null

Title for the saved clip

Example:

"Security Incident - Motion Detected"

Response

200 - application/json

OK

Response object for saving a policy alert as a clip.

error · boolean | null

errorMsg · string | null

warningMsg · string | null