Live Platform API

Restreams

createRestream

Create a restream for the specified stream


/live/stream/{id}/restreams

Parameters

Path parameters
Name Description
id*
String
Live stream ID.
Required
Body parameters
Name Description
restreamCreateModel *

Responses

Status: 200 - Restream has been created.

Status: 400 - Request is badly formatted

Status: 401 - Client is unauthorized.

Status: 403 - Client does not have privileges for this operation.

Status: 404 - RTMP Delivery Alias could not be created.

deleteRestream

Delete the specified restream


/live/stream/{id}/restream/{restreamId}

Parameters

Path parameters
Name Description
id*
String
Live stream ID.
Required
restreamId*
String
Restream ID
Required

Responses

Status: 200 - Restream has been deleted.

Status: 401 - Client is unauthorized.

Status: 403 - Client does not have privileges for this operation.

Status: 404 - Restream does not exist.

getPublicationRestreams

List restreams.

Returns a list of restreams for the current publication. When there are no restreams, an empty list is returned. 


/live/restreams

Parameters

Responses

Status: 200 - The resulting list of restreams.

Status: 401 - Client is unauthorized.

Status: 403 - Client does not have privileges for this operation.

getRestreamData

Get details for the specified restream


/live/stream/{id}/restream/{restreamId}

Parameters

Path parameters
Name Description
id*
String
Stream ID.
Required
restreamId*
String
Restream ID.
Required

Responses

Status: 200 - Request succesful.

Status: 401 - Client is unauthorized.

Status: 403 - Client does not have privileges for this operation.

Status: 404 - Restream does not exist.

getStreamRestreams

List restreams.

Returns a list of restreams for the specified live stream. When there are no restreams, an empty list is returned. 


/live/stream/{id}/restreams

Parameters

Path parameters
Name Description
id*
String
Live stream ID.
Required

Responses

Status: 200 - The resulting list of restreams.

Status: 401 - Client is unauthorized.

Status: 403 - Client does not have privileges for this operation.

Status: 404 - Specified livestream doesn't exist

updateRestreamState

Updates the state for the specified restream.


/live/stream/{id}/restream/{restreamId}/state

Parameters

Path parameters
Name Description
id*
String
Stream ID.
Required
restreamId*
String
Restream ID.
Required
Body parameters
Name Description
options *

Responses

Status: 200 - Restream state has been updated.

Status: 400 - Request was not properly formatted.

Status: 401 - Client does not have privileges for this operation.

Status: 403 - Client does not have privileges for this operation.

Status: 404 - Restream does not exist.

RtmpDeliveryAliases

createRtmpStreamDeliveryAlias

Create RTMP Delivery Alias for the specified RTMP stream


/live/stream/{id}/rtmp-delivery-aliases

Parameters

Path parameters
Name Description
id*
String
Live stream ID.
Required
Body parameters
Name Description
rtmpDeliveryAliasCreateModel *

Responses

Status: 200 - RTMP Delivery Alias has been created.

Status: 400 - Request is badly formatted

Status: 401 - Client is unauthorized.

Status: 403 - Client does not have privileges for this operation.

Status: 404 - RTMP Delivery Alias could not be created.

deleteRtmpStreamDeliveryAlias

Delete the specified RTMP Delivery Alias for the specified RTMP stream


/live/stream/{id}/rtmp-delivery-alias/{rtmpApp}/{rtmpStreamPath}

Parameters

Path parameters
Name Description
id*
String
Live stream ID.
Required
rtmpApp*
String
RTMP App Alias
Required
rtmpStreamPath*
String
RTMP Alias Stream Path
Required

Responses

Status: 200 - RTMP Delivery Alias has been deleted.

Status: 401 - Client is unauthorized.

Status: 403 - Client does not have privileges for this operation.

Status: 404 - RTMP Delivery Alias does not exist.

getRtmpStreamDeliveryAlias

Get the configured RTMP Delivery Aliases for specified RTMP stream.


/live/stream/{id}/rtmp-delivery-aliases

Parameters

Path parameters
Name Description
id*
String
Live stream ID.
Required

Responses

Status: 200 - Request succesful.

Status: 400 - Invalid request.

Status: 401 - Client is unauthorized.

Status: 403 - Client does not have privileges to get the RTMP Delivery Aliases.

Status: 404 - Live stream does not exist.

Stream

createLiveStream

Create a new live stream.


/live/stream

Parameters

Body parameters
Name Description
createLiveStreamModel *

Responses

Status: 200 - Live stream is creating.

Status: 400 - Request is badly formatted

Status: 401 - Client is unauthorized.

Status: 403 - Client does not have privileges for this operation.

Status: 404 - Live stream could not be created.

deleteLiveStream

Delete the specified live stream.


/live/stream/{id}

Parameters

Path parameters
Name Description
id*
String
Stream ID.
Required

Responses

Status: 202 - Live stream is being deleted.

Status: 400 - Live stream is already being deleted.

Status: 401 - Client is unauthorized.

Status: 403 - Client does not have privileges for this operation.

Status: 404 - Live stream does not exist.

getLiveStreamData

Get details for the specified live stream


/live/stream/{id}

Parameters

Path parameters
Name Description
id*
String
Stream ID.
Required

Responses

Status: 200 - Request succesful.

Status: 401 - Client is unauthorized.

Status: 403 - Client does not have privileges for this operation.

Status: 404 - Live stream does not exist.

getLiveStreams

List live streams.

Returns a list of live stream summaries for the current publication. Live streams with state `deleting` or `deleted` are not included. When there are no live streams, an empty list is returned. 


/live/stream

Parameters

Responses

Status: 200 - The resulting list of live streams.

Status: 401 - Client is unauthorized.

Status: 403 - Client does not have privileges for this operation.

pauseLiveStream

Pause live stream


/live/stream/{id}/pause

Parameters

Path parameters
Name Description
id*
String
Stream ID.
Required

Responses

Status: 200 - Request succesful.

Status: 401 - Client is unauthorized.

Status: 403 - Client does not have privileges for this operation.

Status: 404 - Live stream does not exist.

resetLiveStreamIngest

Reset livestream ingest


/live/stream/{id}/reset-ingest

Parameters

Path parameters
Name Description
id*
String
Stream ID.
Required

Responses

Status: 200 - Request succesful.

Status: 401 - Client is unauthorized.

Status: 403 - Client does not have privileges for this operation.

Status: 404 - Live stream does not exist.

resumeLiveStream

Resume live stream


/live/stream/{id}/resume

Parameters

Path parameters
Name Description
id*
String
Stream ID.
Required

Responses

Status: 200 - Request succesful.

Status: 401 - Client is unauthorized.

Status: 403 - Client does not have privileges for this operation.

Status: 404 - Live stream does not exist.

StreamRecording

updateLiveStreamRecordingStatus

Updates the recording status for the specified live stream.


/live/stream/{id}/recording

Parameters

Path parameters
Name Description
id*
String
Live stream ID
Required
Body parameters
Name Description
options *

Responses

Status: 202 - Recording status has been updated.

Status: 400 - Request was not properly formatted.

Status: 401 - Client does not have privileges for this operation.

Status: 403 - Client does not have privileges for this operation.

Status: 404 - Live stream does not exist.