List Recording Templates
List recording templates
Request
Request-Line
GET /lls/v1.0/template/recording
Request
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
domain | String | Optional | ingest domain name |
app | String | Optional | app name. if not specified, the recording template will be applied to all apps. |
stream | String | Optional | stream name. if not specified, the recording template will be applied to all streams. |
recordingFrom | String | Optional | recording from. Valid values: ingest, delivery. |
bucket | String | Optional | bucket name to store the recording. |
Response
Response Body
Parameter | Type | Required | Description |
---|---|---|---|
templates | Array | Mandatory | Array of Recording Template Object. |
Object: Recording Template
Name | Type | Required | Description |
---|---|---|---|
templateName | String | Mandatory | recording template name. |
created | Timestamp | Mandatory | Timestamp of created time in UTC timezone. Default is now. |
status | String | Mandatory | Status of recording template. Valid values: active, inactive. |
domain | String | Mandatory | ingest domain name |
app | String | Optional | app name. if not specified, the recording template will be applied to all apps. |
stream | String | Optional | stream name. if not specified, the recording template will be applied to all streams. |
recordingFrom | String | Mandatory | recording from. Valid values: ingest, delivery. |
recordingFormat | Array | Mandatory | recording formats. Valid values: mp4, hls, dash. |
bucket | String | Mandatory | bucket name to store the recording. |
path | String | Mandatory | storage path under the bucket. |
Examples
List recording templates by domain
Request
GET /lls/v1.0/template/recording?domain=ingest.example.com HTTP/1.1
Successful Response Body
{
"templates": [
{
"templateName": "domainTemplate",
"created": "2025-07-15T08:47:10Z",
"status": "active",
"domain": "ingest.example.com",
"recordingFrom": "ingest",
"recordingFormat": ["mp4", "hls"],
"bucket": "my-bucket",
"path": "/recording/mp4/"
},
{
"templateName": "appTemplate",
"created": "2025-07-15T08:48:30Z",
"status": "inactive",
"domain": "ingest.example.com",
"app": "live",
"recordingFrom": "ingest",
"recordingFormat": ["hls"],
"bucket": "my-bucket",
"path": "/recording/hls/"
},
{
"templateName": "streamTemplate",
"created": "2025-07-15T08:49:45Z",
"status": "active",
"domain": "ingest.example.com",
"app": "live",
"stream": "stream1",
"recordingFrom": "ingest",
"recordingFormat": ["hls"],
"bucket": "my-bucket",
"path": "/recording/hls/"
},
{
"templateName": "deliveryTemplate",
"created": "2025-07-15T08:51:30Z",
"status": "active",
"domain": "ingest.example.com",
"app": "live",
"stream": "stream1",
"recordingFrom": "delivery",
"recordingFormat": ["hls"],
"bucket": "my-bucket",
"path": "/recording/hls/"
}
]
}
List recording templates by domain and app
Request
GET /lls/v1.0/template/recording?domain=ingest.example.com&app=live HTTP/1.1
Successful Response Body
{
"templates": [
{
"templateName": "appTemplate",
"created": "2025-07-15T08:48:30Z",
"status": "inactive",
"domain": "ingest.example.com",
"app": "live",
"recordingFrom": "ingest",
"recordingFormat": ["hls"],
"bucket": "my-bucket",
"path": "/recording/hls/"
},
{
"templateName": "streamTemplate",
"created": "2025-07-15T08:49:45Z",
"status": "active",
"domain": "ingest.example.com",
"app": "live",
"stream": "stream1",
"recordingFrom": "ingest",
"recordingFormat": ["hls"],
"bucket": "my-bucket",
"path": "/recording/hls/"
},
{
"templateName": "deliveryTemplate",
"created": "2025-07-15T08:51:30Z",
"status": "active",
"domain": "ingest.example.com",
"app": "live",
"stream": "stream1",
"recordingFrom": "delivery",
"recordingFormat": ["hls"],
"bucket": "my-bucket",
"path": "/recording/hls/"
}
]
}
List recording templates by domain, app and stream
Request
GET /lls/v1.0/template/recording?domain=ingest.example.com&app=live&stream=stream1 HTTP/1.1
Successful Response Body
{
"templates": [
{
"templateName": "streamTemplate",
"created": "2025-07-15T08:49:45Z",
"status": "active",
"domain": "ingest.example.com",
"app": "live",
"stream": "stream1",
"recordingFrom": "ingest",
"recordingFormat": ["hls"],
"bucket": "my-bucket",
"path": "/recording/hls/"
},
{
"templateName": "deliveryTemplate",
"created": "2025-07-15T08:51:30Z",
"status": "active",
"domain": "ingest.example.com",
"app": "live",
"stream": "stream1",
"recordingFrom": "delivery",
"recordingFormat": ["hls"],
"bucket": "my-bucket",
"path": "/recording/hls/"
}
]
}
List recording templates by recordingFrom
Request
GET /lls/v1.0/template/recording?recordingFrom=ingest HTTP/1.1
Successful Response Body
{
"templates": [
{
"templateName": "domainTemplate",
"created": "2025-07-15T08:47:10Z",
"status": "active",
"domain": "ingest.example.com",
"recordingFrom": "ingest",
"recordingFormat": ["mp4", "hls"],
"bucket": "my-bucket",
"path": "/recording/mp4/"
},
{
"templateName": "appTemplate",
"created": "2025-07-15T08:48:30Z",
"status": "inactive",
"domain": "ingest.example.com",
"app": "live",
"recordingFrom": "ingest",
"recordingFormat": ["hls"],
"bucket": "my-bucket",
"path": "/recording/hls/"
},
{
"templateName": "streamTemplate",
"created": "2025-07-15T08:49:45Z",
"status": "active",
"domain": "ingest.example.com",
"app": "live",
"stream": "stream1",
"recordingFrom": "ingest",
"recordingFormat": ["hls"],
"bucket": "my-bucket",
"path": "/recording/hls/"
},
{
"templateName": "otherDomainTemplate",
"created": "2025-07-14T10:30:15Z",
"status": "active",
"domain": "ingest2.example.com",
"recordingFrom": "ingest",
"recordingFormat": ["mp4"],
"bucket": "other-bucket",
"path": "/recording/mp4/"
}
]
}
List recording templates by bucket
Request
GET /lls/v1.0/template/recording?bucket=my-bucket HTTP/1.1
Successful Response Body
{
"templates": [
{
"templateName": "domainTemplate",
"created": "2025-07-15T08:47:10Z",
"status": "active",
"domain": "ingest.example.com",
"recordingFrom": "ingest",
"recordingFormat": ["mp4", "hls"],
"bucket": "my-bucket",
"path": "/recording/mp4/"
},
{
"templateName": "appTemplate",
"created": "2025-07-15T08:48:30Z",
"status": "inactive",
"domain": "ingest.example.com",
"app": "live",
"recordingFrom": "ingest",
"recordingFormat": ["hls"],
"bucket": "my-bucket",
"path": "/recording/hls/"
},
{
"templateName": "streamTemplate",
"created": "2025-07-15T08:49:45Z",
"status": "active",
"domain": "ingest.example.com",
"app": "live",
"stream": "stream1",
"recordingFrom": "ingest",
"recordingFormat": ["hls"],
"bucket": "my-bucket",
"path": "/recording/hls/"
},
{
"templateName": "deliveryTemplate",
"created": "2025-07-15T08:51:30Z",
"status": "active",
"domain": "ingest.example.com",
"app": "live",
"stream": "stream1",
"recordingFrom": "delivery",
"recordingFormat": ["hls"],
"bucket": "my-bucket",
"path": "/recording/hls/"
}
]
}
Rate Limits
Rate limiting is posed upon the API, please kindly check your API calls to ensure complying with the rate limit below:
- 100 requests per minute
- 1000 requests per hour