Skip navigation
Kinescope help center

Restreams

Create and manage restreams.

Restreams

Create restream

POST {{baseHost}}/v2/live/events/:event_id/restreams

Adds an RTMP restream target to the event — the live stream will be mirrored there.

Request body (json)
{  "name": "Restream name",  "url": "rtmp://rtmp.kinescope.io/live",  "key": "stream key",  "description": "Description",  "enabled": true}
Responses
{    "data": {        "id": "<UUID>",        "event_id": "<UUID>",        "name": "Restream name",        "url": "rtmp://rtmp.kinescope.io/live",        "key": "stream key",        "status": "disconnected",        "enabled": true,        "description": "Description",        "created_at": "2022-11-15T12:50:33.867315Z",        "updated_at": null    }}{    "data": {        "id": "<UUID>",        "event_id": "<UUID>",        "name": "Restream name",        "url": "rtmp://rtmp.kinescope.dev/live",        "key": "stream key",        "status": "disconnected",        "enabled": true,        "description": "Description",        "created_at": "2022-11-15T12:50:33.867315Z",        "updated_at": null    }}

Update restream

PUT {{baseHost}}/v2/live/events/:event_id/restreams/:restream_id

Updates a restream target (URL, stream key, enabled flag).

Request body (json)
{  "name": "Restream name 1",  "url": "rtmp://rtmp.kinescope.io/live",  "key": "stream key",  "description": "Description",  "enabled": true}
Responses
{    "data": {        "id": "<UUID>",        "event_id": "<UUID>",        "name": "Restream name 1",        "url": "rtmp://rtmp.kinescope.io/live",        "key": "stream key",        "status": "disconnected",        "enabled": true,        "description": "Description",        "created_at": "2022-11-15T12:50:33.867315Z",        "updated_at": "2022-11-15T12:51:28.175339Z"    }}{    "data": {        "id": "<UUID>",        "event_id": "<UUID>",        "name": "Restream name 1",        "url": "rtmp://rtmp.kinescope.dev/live",        "key": "stream key",        "status": "disconnected",        "enabled": true,        "description": "Description",        "created_at": "2022-11-15T12:50:33.867315Z",        "updated_at": "2022-11-15T12:51:28.175339Z"    }}

Get restream

GET {{baseHost}}/v2/live/events/:event_id/restreams/:restream_id

Retrieves the details of a single restream by its unique ID.

Responses
{  "data": {    "id": "<UUID>",    "event_id": "<UUID>",    "name": "23234",    "url": "rtmp://rtmp.kinescope.io/live",    "key": "23234234",    "status": "disconnected",    "enabled": false,    "description": "",    "created_at": "2026-03-03T10:55:22.991595Z",    "updated_at": "2026-03-03T11:10:05.345611Z"  }}

List restreams

GET {{baseHost}}/v2/live/events/:event_id/restreams/:restream_id

Returns a list of restreams. Results are paginated and can be filtered via query parameters.

Responses
{  "data": {    "id": "<UUID>",    "event_id": "<UUID>",    "name": "23234",    "url": "rtmp://rtmp.kinescope.io/live",    "key": "23234234",    "status": "disconnected",    "enabled": false,    "description": "",    "created_at": "2026-03-03T10:55:22.991595Z",    "updated_at": "2026-03-03T11:10:05.345611Z"  }}

Delete restream

DELETE {{baseHost}}/v2/live/events/:event_id/restreams/:restream_id

Permanently deletes the restream. This action cannot be undone.