Skip to content
Tilecast Docs

renewLiveStream

POST
/api/v1/screens/{id}/live-stream/{sessionId}/renew
curl --request POST \
  --url https://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/live-stream/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/renew \
  --header 'X-CSRF-Token: example'

Renew a live MJPEG relay session. Requires an authenticated dashboard user with the write scope. Cookie-authenticated unsafe requests require X-CSRF-Token.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
sessionId
required
string format: uuid

Header Parameters

Section titled “Header Parameters”
X-CSRF-Token
required
string

Responses

Section titled “ Responses ”

200

Section titled “200”

Live stream session renewed

Media typeapplication/json
object
data
required
object
id
required
string format: uuid
screenId
required
string format: uuid
active
required
boolean
expiresAt
required
string format: date-time
frameIntervalMillis
required
integer
maxWidth
required
integer
maxHeight
required
integer
maxFrameBytes
required
integer
Examplegenerated
{
  "data": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "screenId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "active": true,
    "expiresAt": "2026-04-15T12:00:00Z",
    "frameIntervalMillis": 1,
    "maxWidth": 1,
    "maxHeight": 1,
    "maxFrameBytes": 1
  }
}

401

Section titled “401”

Dashboard authentication required

403

Section titled “403”

Screen scope forbids this screen

404

Section titled “404”

Live stream session not found