GET
/
stream

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

streamsonly
string

Response

200 - application/json
name
string
required
createdAt
number

Timestamp (in milliseconds) at which stream object was created

createdByTokenName
string

Name of the token used to create this object

creatorId
object
id
string
ingestRate
number

Rate at which sourceBytes increases (bytes/second)

isActive
boolean

If currently active

isHealthy
any
issues
any
kind
string
deprecated
lastSeen
number
lastTerminatedAt
number | null

Timestamp (in milliseconds) when the stream was last terminated

multistream
object
outgoingRate
number

Rate at which transcodedBytes increases (bytes/second)

parentId
string

Points to parent stream object

playbackId
string

The playback ID to use with the Playback Info endpoint to retrieve playback URLs.

playbackPolicy
object | null

Whether the playback policy for an asset or stream is public or signed

profiles
object[]

Profiles to transcode the stream into. If not specified, a default set of profiles will be used with 240p, 360p, 480p and 720p resolutions. Keep in mind that the source rendition is always kept.

projectId
string

The ID of the project

pull
object

Configuration for a stream that should be actively pulled from an external source, rather than pushed to Livepeer. If specified, the stream will not have a streamKey.

record
boolean

Should this stream be recorded? Uses default settings. For more customization, create and configure an object store.

recordingSpec
object

Configuration for recording the stream. This can only be set if record is true.

renditions
object
sourceBytes
number
sourceSegments
number
sourceSegmentsDuration
number

Duration of all the source segments, sec

streamKey
string

Used to form RTMP ingest URL

suspended
boolean

If currently suspended

transcodedBytes
number
transcodedSegments
number
transcodedSegmentsDuration
number

Duration of all the transcoded segments, sec

userId
string
deprecated
userTags
object

User input tags associated with the stream