Assembles a VOD HLS recording from Red5 partition-based HLS artifacts stored in S3.

Behavior: Scans the live channel's Red5 HLS upload location for partition folders
that overlap the specified time window, aggregates the relevant video and subtitle segments,
generates an assembled VOD HLS master manifest and variant playlists in S3, pre-registers
a placeholder Nomad asset, and enqueues a batch action to materialize the recording. The live
channel state is never modified by this operation.

Authorization: Requires a valid Bearer token.

Side Effects: Writes assembled manifest files to the channel's HLS S3 bucket and
registers a placeholder asset. Does not modify the live channel entity.

Error Scenarios: Returns 400 if the channel is not a Red5 HLS channel or
no segments are found for the specified time range.

Background mode: When runInBackground is true the
operation is dispatched to a background thread and the endpoint returns 202 Accepted
immediately, avoiding gateway timeouts for large time windows. Results are written to
the audit log; no response body is returned in this mode.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique identifier of the live channel.

Query Params
boolean
Defaults to false

When true, process asynchronously and return 202 immediately.

Body Params

The recording request parameters.

Request model for assembling a VOD recording from Red5 HLS partition artifacts.

string
required
length ≥ 1

Gets or sets the base file name for the recording asset (without extension).

uuid
required

Gets or sets the destination Nomad folder asset ID where the recording will be registered.

date-time
required

Gets or sets the desired recording start date/time in UTC.

double
required

Gets or sets the desired recording duration in seconds.

Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

202

The recording job was accepted and is running in the background.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json