Share multiple clips in a single page

Share multiple clips in a single page

POST /api/event/createSharedClipGroupV3

Share multiple clips in a single page

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/event/createSharedClipGroupV3 \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "expirationTimeSecs": 86400,
  "plaintextPassword": "mypassword123",
  "title": "Security Incident - Main Entrance",
  "uuids": [
    {
      "alertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "eventUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "shareUrl": "https://share.rhombus.com/clips/abc123",
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "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 creating a shared clip group.

expirationTimeSecs · integer<int32> | null

Expiration time in seconds for the shared clip group

Example:

86400

plaintextPassword · string | null

Optional password for accessing the shared clip group

Example:

"mypassword123"

title · string | null

Title for the shared clip group

Example:

"Security Incident - Main Entrance"

uuids · object[] | null

List of UUIDs for clips to include in the shared group

Show child attributes

Response

200 - application/json

OK

Response object for creating a shared clip group.

error · boolean | null

errorMsg · string | null

shareUrl · string | null

URL for accessing the shared clip group

Example:

"https://share.rhombus.com/clips/abc123"

uuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

warningMsg · string | null