Skip to main content
POST
/
api
/
event
/
updateSavedClip
Selectively update a saved clip
curl --request POST \
  --url https://api2.rhombussystems.com/api/event/updateSavedClip \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "savedClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "accessSettings": {
    "allowedRoles": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "allowedUsers": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "visibility": "PRIVATE"
  },
  "description": "Updated description of the security incident",
  "title": "Updated Security Incident"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for updating a saved clip.

savedClipUuid
string<RUUID> | null
required

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

accessSettings
object

Visibility setting for the clip

description
string | null

Updated description for the saved clip

Example:

"Updated description of the security incident"

title
string | null

Updated title for the saved clip

Example:

"Updated Security Incident"

Response

200 - application/json

OK

Response object for updating a saved clip.

error
boolean | null
errorMsg
string | null
warningMsg
string | null