Skip to content
Cloudflare API
Start here
API Reference
Stream

Live Inputs

List live inputs
client.stream.liveInputs.list(LiveInputListParams { account_id, include_counts } params, RequestOptionsoptions?): LiveInputListResponse { liveInputs, range, total }
GET/accounts/{account_id}/stream/live_inputs
Retrieve a live input
client.stream.liveInputs.get(stringliveInputIdentifier, LiveInputGetParams { account_id } params, RequestOptionsoptions?): LiveInput { created, deleteRecordingAfterDays, enabled, 11 more }
GET/accounts/{account_id}/stream/live_inputs/{live_input_identifier}
Create a live input
client.stream.liveInputs.create(LiveInputCreateParams { account_id, defaultCreator, deleteRecordingAfterDays, 3 more } params, RequestOptionsoptions?): LiveInput { created, deleteRecordingAfterDays, enabled, 11 more }
POST/accounts/{account_id}/stream/live_inputs
Update a live input
client.stream.liveInputs.update(stringliveInputIdentifier, LiveInputUpdateParams { account_id, defaultCreator, deleteRecordingAfterDays, 3 more } params, RequestOptionsoptions?): LiveInput { created, deleteRecordingAfterDays, enabled, 11 more }
PUT/accounts/{account_id}/stream/live_inputs/{live_input_identifier}
Delete a live input
client.stream.liveInputs.delete(stringliveInputIdentifier, LiveInputDeleteParams { account_id } params, RequestOptionsoptions?): void
DELETE/accounts/{account_id}/stream/live_inputs/{live_input_identifier}
ModelsExpand Collapse
LiveInput { created, deleteRecordingAfterDays, enabled, 11 more }

Details about a live input.

created?: string

The date and time the live input was created.

formatdate-time
deleteRecordingAfterDays?: number

Indicates the number of days after which the live inputs recordings will be deleted. When a stream completes and the recording is ready, the value is used to calculate a scheduled deletion date for that recording. Omit the field to indicate no change, or include with a null value to remove an existing scheduled deletion.

minimum30
enabled?: boolean

Indicates whether the live input is enabled and can accept streams.

meta?: unknown

A user modifiable key-value store used to reference other systems of record for managing live inputs.

modified?: string

The date and time the live input was last modified.

formatdate-time
recording?: Recording { allowedOrigins, hideLiveViewerCount, mode, 2 more }

Records the input to a Cloudflare Stream video. Behavior depends on the mode. In most cases, the video will initially be viewable as a live video and transition to on-demand after a condition is satisfied.

allowedOrigins?: Array<string>

Lists the origins allowed to display videos created with this input. Enter allowed origin domains in an array and use * for wildcard subdomains. An empty array allows videos to be viewed on any origin.

hideLiveViewerCount?: boolean

Disables reporting the number of live viewers when this property is set to true.

mode?: "off" | "automatic"

Specifies the recording behavior for the live input. Set this value to off to prevent a recording. Set the value to automatic to begin a recording and transition to on-demand after Stream Live stops receiving input.

One of the following:
"off"
"automatic"
requireSignedURLs?: boolean

Indicates if a video using the live input has the requireSignedURLs property set. Also enforces access controls on any video recording of the livestream with the live input.

timeoutSeconds?: number

Determines the amount of time a live input configured in automatic mode should wait before a recording transitions from live to on-demand. 0 is recommended for most use cases and indicates the platform default should be used.

rtmps?: Rtmps { streamKey, url }

Details for streaming to an live input using RTMPS.

streamKey?: string

The secret key to use when streaming via RTMPS to a live input.

url?: string

The RTMPS URL you provide to the broadcaster, which they stream live video to.

rtmpsPlayback?: RtmpsPlayback { streamKey, url }

Details for playback from an live input using RTMPS.

streamKey?: string

The secret key to use for playback via RTMPS.

url?: string

The URL used to play live video over RTMPS.

srt?: Srt { passphrase, streamId, url }

Details for streaming to a live input using SRT.

passphrase?: string

The secret key to use when streaming via SRT to a live input.

streamId?: string

The identifier of the live input to use when streaming via SRT.

url?: string

The SRT URL you provide to the broadcaster, which they stream live video to.

srtPlayback?: SrtPlayback { passphrase, streamId, url }

Details for playback from an live input using SRT.

passphrase?: string

The secret key to use for playback via SRT.

streamId?: string

The identifier of the live input to use for playback via SRT.

url?: string

The URL used to play live video over SRT.

status?: "connected" | "reconnected" | "reconnecting" | 5 more | null

The connection status of a live input.

One of the following:
"connected"
"reconnected"
"reconnecting"
"client_disconnect"
"ttl_exceeded"
"failed_to_connect"
"failed_to_reconnect"
"new_configuration_accepted"
uid?: string

A unique identifier for a live input.

maxLength32
webRTC?: WebRtc { url }

Details for streaming to a live input using WebRTC.

url?: string

The WebRTC URL you provide to the broadcaster, which they stream live video to.

webRTCPlayback?: WebRtcPlayback { url }

Details for playback from a live input using WebRTC.

url?: string

The URL used to play live video over WebRTC.

LiveInputListResponse { liveInputs, range, total }
liveInputs?: Array<LiveInput>
created?: string

The date and time the live input was created.

formatdate-time
deleteRecordingAfterDays?: number

Indicates the number of days after which the live inputs recordings will be deleted. When a stream completes and the recording is ready, the value is used to calculate a scheduled deletion date for that recording. Omit the field to indicate no change, or include with a null value to remove an existing scheduled deletion.

minimum30
enabled?: boolean

Indicates whether the live input is enabled and can accept streams.

meta?: unknown

A user modifiable key-value store used to reference other systems of record for managing live inputs.

modified?: string

The date and time the live input was last modified.

formatdate-time
uid?: string

A unique identifier for a live input.

maxLength32
range?: number

The total number of remaining live inputs based on cursor position.

total?: number

The total number of live inputs that match the provided filters.

Live InputsOutputs

List all outputs associated with a specified live input
client.stream.liveInputs.outputs.list(stringliveInputIdentifier, OutputListParams { account_id } params, RequestOptionsoptions?): SinglePage<Output { enabled, streamKey, uid, url } >
GET/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs
Create a new output, connected to a live input
client.stream.liveInputs.outputs.create(stringliveInputIdentifier, OutputCreateParams { account_id, streamKey, url, enabled } params, RequestOptionsoptions?): Output { enabled, streamKey, uid, url }
POST/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs
Update an output
client.stream.liveInputs.outputs.update(stringliveInputIdentifier, stringoutputIdentifier, OutputUpdateParams { account_id, enabled } params, RequestOptionsoptions?): Output { enabled, streamKey, uid, url }
PUT/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}
Delete an output
client.stream.liveInputs.outputs.delete(stringliveInputIdentifier, stringoutputIdentifier, OutputDeleteParams { account_id } params, RequestOptionsoptions?): void
DELETE/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}
ModelsExpand Collapse
Output { enabled, streamKey, uid, url }
enabled?: boolean

When enabled, live video streamed to the associated live input will be sent to the output URL. When disabled, live video will not be sent to the output URL, even when streaming to the associated live input. Use this to control precisely when you start and stop simulcasting to specific destinations like YouTube and Twitch.

streamKey?: string

The streamKey used to authenticate against an output's target.

uid?: string

A unique identifier for the output.

maxLength32
url?: string

The URL an output uses to restream.