---
title: Retrieve a live input
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Stream](https://developers.cloudflare.com/api/resources/stream)
[Live Inputs](https://developers.cloudflare.com/api/resources/stream/subresources/live_inputs)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Retrieve a live input
GET/accounts/{account\_id}/stream/live\_inputs/{live\_input\_identifier}
Retrieves details of an existing live input.
##### Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
**Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**X-Auth-Email: user@example.com
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required)
`Stream Write``Stream Read`
##### P ath ParametersExpand Collapse
account\_id: string
Identifier.
maxLength32
[Link to this property](<#(resource)%20stream.live_inputs%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)
live\_input\_identifier: string
A unique identifier for a live input.
maxLength32
[Link to this property](<#(resource)%20stream.live_inputs%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20live_input_identifier%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of object {code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20stream.live_inputs%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of object {code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20stream.live_inputs%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
success: true
Whether the API call was successful.
[Link to this property](<#(resource)%20stream.live_inputs%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result: optional LiveInput { created, deleteRecordingAfterDays, enabled, 14 more }
Details about a live input.
created: optional string
The date and time the live input was created.
formatdate-time
Link to this property
deleteRecordingAfterDays: optional 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
Link to this property
enabled: optional boolean
Indicates whether the live input is enabled and can accept streams.
Link to this property
keysRotatedAt: optional string
The date and time the live input keys were last rotated. Omitted for live inputs that have never had their keys rotated.
formatdate-time
Link to this property
meta: optional unknown
A user modifiable key-value store used to reference other systems of record for managing live inputs.
Link to this property
modified: optional string
The date and time the live input was last modified.
formatdate-time
Link to this property
playback: optional object {dash, hls }
Details for playing a live input’s broadcast using the HLS or DASH manifests. URLs reference the live input ID.
dash: string
The DASH manifest URL used to play live video, referencing the live input ID.
Link to this property
hls: string
The HLS manifest URL used to play live video, referencing the live input ID.
Link to this property
Link to this property
preferLowLatency: optional boolean
When enabled, the live stream is delivered using Low-Latency HLS (LL-HLS), reducing glass-to-glass latency for viewers at the cost of reduced player compatibility.
Link to this property
recording: optional object {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: optional array of 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.
Link to this property
hideLiveViewerCount: optional boolean
Disables reporting the number of live viewers when this property is set to true.
Link to this property
mode: optional "off"or "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"
Link to this property
"automatic"
Link to this property
Link to this property
requireSignedURLs: optional 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.
Link to this property
timeoutSeconds: optional 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.
Link to this property
Link to this property
rtmps: optional object {streamKey, url }
Details for streaming to an live input using RTMPS.
streamKey: optional string
The secret key to use when streaming via RTMPS to a live input.
Link to this property
url: optional string
The RTMPS URL you provide to the broadcaster, which they stream live video to.
Link to this property
Link to this property
rtmpsPlayback: optional object {streamKey, url }
Details for playback from an live input using RTMPS.
streamKey: optional string
The secret key to use for playback via RTMPS.
Link to this property
url: optional string
The URL used to play live video over RTMPS.
Link to this property
Link to this property
srt: optional object {passphrase, streamId, url }
Details for streaming to a live input using SRT.
passphrase: optional string
The secret key to use when streaming via SRT to a live input.
Link to this property
streamId: optional string
The identifier of the live input to use when streaming via SRT.
Link to this property
url: optional string
The SRT URL you provide to the broadcaster, which they stream live video to.
Link to this property
Link to this property
srtPlayback: optional object {passphrase, streamId, url }
Details for playback from an live input using SRT.
passphrase: optional string
The secret key to use for playback via SRT.
Link to this property
streamId: optional string
The identifier of the live input to use for playback via SRT.
Link to this property
url: optional string
The URL used to play live video over SRT.
Link to this property
Link to this property
status: optional "connected"or "reconnected"or "reconnecting"or 5 more
The connection status of a live input.
One of the following:
"connected"
Link to this property
"reconnected"
Link to this property
"reconnecting"
Link to this property
"client\_disconnect"
Link to this property
"ttl\_exceeded"
Link to this property
"failed\_to\_connect"
Link to this property
"failed\_to\_reconnect"
Link to this property
"new\_configuration\_accepted"
Link to this property
Link to this property
uid: optional string
A unique identifier for a live input.
maxLength32
Link to this property
webRTC: optional object {url }
Details for streaming to a live input using WebRTC.
url: optional string
The WebRTC URL you provide to the broadcaster, which they stream live video to.
Link to this property
Link to this property
webRTCPlayback: optional object {url }
Details for playback from a live input using WebRTC.
url: optional string
The URL used to play live video over WebRTC.
Link to this property
Link to this property
[Link to this property](<#(resource)%20stream.live_inputs%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
### Retrieve a live input
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/stream/live_inputs/$LIVE_INPUT_IDENTIFIER \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": {
"created": "2014-01-02T02:20:00Z",
"deleteRecordingAfterDays": 45,
"enabled": true,
"keysRotatedAt": "2014-01-02T02:20:00Z",
"meta": {
"name": "test stream 1"
},
"modified": "2014-01-02T02:20:00Z",
"playback": {
"dash": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/66be4bf738797e01e1fca35a7bdecdcd/manifest/video.mpd",
"hls": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/66be4bf738797e01e1fca35a7bdecdcd/manifest/video.m3u8"
},
"preferLowLatency": true,
"recording": {
"allowedOrigins": [
"example.com"
],
"hideLiveViewerCount": false,
"mode": "off",
"requireSignedURLs": false,
"timeoutSeconds": 0
},
"rtmps": {
"streamKey": "2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada",
"url": "rtmps://live.cloudflare.com:443/live/"
},
"rtmpsPlayback": {
"streamKey": "2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada",
"url": "rtmps://live.cloudflare.com:443/live/"
},
"srt": {
"passphrase": "2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada",
"streamId": "f256e6ea9341d51eea64c9454659e576",
"url": "srt://live.cloudflare.com:778"
},
"srtPlayback": {
"passphrase": "2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada",
"streamId": "f256e6ea9341d51eea64c9454659e576",
"url": "rtmps://live.cloudflare.com:443/live/"
},
"status": "connected",
"uid": "66be4bf738797e01e1fca35a7bdecdcd",
"webRTC": {
"url": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/publish"
},
"webRTCPlayback": {
"url": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/play"
}
}
}
```
##### Returns Examples
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": {
"created": "2014-01-02T02:20:00Z",
"deleteRecordingAfterDays": 45,
"enabled": true,
"keysRotatedAt": "2014-01-02T02:20:00Z",
"meta": {
"name": "test stream 1"
},
"modified": "2014-01-02T02:20:00Z",
"playback": {
"dash": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/66be4bf738797e01e1fca35a7bdecdcd/manifest/video.mpd",
"hls": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/66be4bf738797e01e1fca35a7bdecdcd/manifest/video.m3u8"
},
"preferLowLatency": true,
"recording": {
"allowedOrigins": [
"example.com"
],
"hideLiveViewerCount": false,
"mode": "off",
"requireSignedURLs": false,
"timeoutSeconds": 0
},
"rtmps": {
"streamKey": "2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada",
"url": "rtmps://live.cloudflare.com:443/live/"
},
"rtmpsPlayback": {
"streamKey": "2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada",
"url": "rtmps://live.cloudflare.com:443/live/"
},
"srt": {
"passphrase": "2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada",
"streamId": "f256e6ea9341d51eea64c9454659e576",
"url": "srt://live.cloudflare.com:778"
},
"srtPlayback": {
"passphrase": "2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada",
"streamId": "f256e6ea9341d51eea64c9454659e576",
"url": "rtmps://live.cloudflare.com:443/live/"
},
"status": "connected",
"uid": "66be4bf738797e01e1fca35a7bdecdcd",
"webRTC": {
"url": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/publish"
},
"webRTCPlayback": {
"url": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/play"
}
}
}
```