APIs.io Engineering Platform Stream Live Inputs API
The Stream Live Inputs API from APIs.io Engineering Platform — 4 operation(s) for stream live inputs.
This API exposes 9 operations across 4 paths, and defines 52 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
9 operations
4 paths
52 schemas
2 DELETE3 GET2 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
APIs.io Engineering Platform Stream Live Inputs API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 9
Across 4 paths, the API surfaces 9 operations — 2 DELETE, 3 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Stream Live Inputs 9
GET
/accounts/{account_id}/stream/live_inputs
APIs.io Engineering Platform List live inputs
POST
/accounts/{account_id}/stream/live_inputs
APIs.io Engineering Platform Create a live input
DELETE
/accounts/{account_id}/stream/live_inputs/{live_input_identifier}
APIs.io Engineering Platform Delete a live input
GET
/accounts/{account_id}/stream/live_inputs/{live_input_identifier}
APIs.io Engineering Platform Retrieve a live input
PUT
/accounts/{account_id}/stream/live_inputs/{live_input_identifier}
APIs.io Engineering Platform Update a live input
GET
/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs
APIs.io Engineering Platform List all outputs associated with a specified live input
POST
/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs
APIs.io Engineering Platform Create a new output, connected to a live input
DELETE
/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}
APIs.io Engineering Platform Delete an output
PUT
/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}
APIs.io Engineering Platform Update an output
Schemas 52
The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are stream_live_input (13 properties), stream_live_input_recording_settings (5 properties), stream_live_input_object_without_url (5 properties), stream_api-response-common-failure (4 properties). Each schema is shown below with its type and property counts.
stream_output_response_collection
stream_create_input_request
object
4 properties
stream_playback_srt
object
Details for playback from an live input using SRT.
3 properties
stream_live_input
object
Details about a live input.
13 properties
stream_playback_webrtc
object
Details for playback from a live input using WebRTC.
1 property
stream_live_input_status
string
The connection status of a live input.
stream_api-response-common
object
3 properties
3 required
stream_live_input_identifier
string
A unique identifier for a live input.
stream_update_input_request
object
4 properties
stream_messages
array
stream_playback_srt_url
string
The URL used to play live video over SRT.
stream_input_webrtc_url
string
The WebRTC URL you provide to the broadcaster, which they stream live video to.
stream_live_input_response_collection
stream_playback_rtmps_stream_key
string
The secret key to use for playback via RTMPS.
stream_output_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, ev…
stream_input_rtmps_url
string
The RTMPS URL you provide to the broadcaster, which they stream live video to.
stream_schemas-identifier
string
Identifier
stream_input_rtmps
object
Details for streaming to an live input using RTMPS.
2 properties
stream_live_input_created
string
The date and time the live input was created.
stream_live_input_recording_settings
object
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 transitio…
5 properties
stream_api-response-single
object
stream_live_input_recording_deletion
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 c…
stream_live_input_recording_timeoutSeconds
integer
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…
stream_live_input_recording_mode
string
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 transiti…
stream_live_input_modified
string
The date and time the live input was last modified.
stream_playback_srt_stream_id
string
The identifier of the live input to use for playback via SRT.
stream_output_url
string
The URL an output uses to restream.
stream_live_input_recording_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 t…
stream_playback_rtmps_url
string
The URL used to play live video over RTMPS.
stream_input_srt_stream_id
string
The identifier of the live input to use when streaming via SRT.
stream_update_output_request
object
1 property
1 required
stream_output_response_single
stream_playback_rtmps
object
Details for playback from an live input using RTMPS.
2 properties
stream_live_input_metadata
object
A user modifiable key-value store used to reference other systems of record for managing live inputs.
stream_api-response-common-failure
object
4 properties
4 required
stream_playback_srt_stream_passphrase
string
The secret key to use for playback via SRT.
stream_output_streamKey
string
The streamKey used to authenticate against an output's target.
stream_output
object
4 properties
stream_playback_webrtc_url
string
The URL used to play live video over WebRTC.
stream_input_webrtc
object
Details for streaming to a live input using WebRTC.
1 property
stream_live_input_recording_hideLiveViewerCount
boolean
Disables reporting the number of live viewers when this property is set to true.
stream_input_srt_stream_passphrase
string
The secret key to use when streaming via SRT to a live input.
stream_include_counts
boolean
Includes the total number of videos associated with the submitted query parameters.
stream_input_rtmps_stream_key
string
The secret key to use when streaming via RTMPS to a live input.
stream_input_srt
object
Details for streaming to a live input using SRT.
3 properties
stream_live_input_default_creator
string
Sets the creator ID asssociated with this live input.
stream_live_input_object_without_url
object
5 properties
stream_input_srt_url
string
The SRT URL you provide to the broadcaster, which they stream live video to.
stream_output_identifier
string
A unique identifier for the output.
stream_create_output_request
object
3 properties
2 required
stream_live_input_response_single
stream_live_input_recording_allowedOrigins
array
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 a…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Stream Live Inputs