Skip to main content
POST
/
api
/
video
/
createSharedTimelapseGroup
Create shared timelapse group
curl --request POST \
  --url https://api2.rhombussystems.com/api/video/createSharedTimelapseGroup \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "description": "Shared timelapse for security review",
  "expirationTimeSecs": 86400,
  "plaintextPassword": "securePassword123",
  "timelapseUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "title": "Security Review"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "shareUrl": "https://example.com/share/timelapse/12345",
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "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 creating a shared timelapse group.

description
string | null

Description for the shared timelapse group

Example:

"Shared timelapse for security review"

expirationTimeSecs
integer<int32> | null

Expiration time in seconds for the shared group

Example:

86400

plaintextPassword
string | null

Plaintext password for the shared timelapse group

Example:

"securePassword123"

timelapseUuids
(string<RUUID> | null)[] | null

List of timelapse UUIDs to include in the shared group

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

title
string | null

Title for the shared timelapse group

Example:

"Security Review"

Response

200 - application/json

OK

Response object for creating a shared timelapse group.

error
boolean | null
errorMsg
string | null
shareUrl
string | null

Share URL for the timelapse group

Example:

"https://example.com/share/timelapse/12345"

uuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

warningMsg
string | null