openapi: 3.0.0 info: version: 2015-07-09 x-release: v4 title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Stream Live Inputs API description: Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Stream Live Inputs paths: /accounts/{account_id}/stream/live_inputs: get: description: Lists the live inputs created for an account. To get the credentials needed to stream to a specific live input, request a single live input. operationId: stream-live-inputs-list-live-inputs parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' - in: query name: include_counts schema: $ref: '#/components/schemas/stream_include_counts' responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' description: List live inputs response failure '200': content: application/json: schema: $ref: '#/components/schemas/stream_live_input_response_collection' description: List live inputs response security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform List live inputs tags: - Stream Live Inputs x-api-token-group: - Stream Write - Stream Read post: description: Creates a live input, and returns credentials that you or your users can use to stream live video to Cloudflare Stream. operationId: stream-live-inputs-create-a-live-input parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/stream_create_input_request' required: true responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' description: Create a live input response failure '200': content: application/json: schema: $ref: '#/components/schemas/stream_live_input_response_single' description: Create a live input response security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Create a live input tags: - Stream Live Inputs x-api-token-group: - Stream Write /accounts/{account_id}/stream/live_inputs/{live_input_identifier}: delete: description: Prevents a live input from being streamed to and makes the live input inaccessible to any future API calls. operationId: stream-live-inputs-delete-a-live-input parameters: - in: path name: live_input_identifier required: true schema: $ref: '#/components/schemas/stream_live_input_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: content: application/json: {} required: true responses: 4XX: content: application/json: {} description: Delete a live input response failure '200': content: application/json: {} description: Delete a live input response security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Delete a live input tags: - Stream Live Inputs x-api-token-group: - Stream Write get: description: Retrieves details of an existing live input. operationId: stream-live-inputs-retrieve-a-live-input parameters: - in: path name: live_input_identifier required: true schema: $ref: '#/components/schemas/stream_live_input_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' description: Retrieve a live input response failure '200': content: application/json: schema: $ref: '#/components/schemas/stream_live_input_response_single' description: Retrieve a live input response security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Retrieve a live input tags: - Stream Live Inputs x-api-token-group: - Stream Write - Stream Read put: description: Updates a specified live input. operationId: stream-live-inputs-update-a-live-input parameters: - in: path name: live_input_identifier required: true schema: $ref: '#/components/schemas/stream_live_input_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/stream_update_input_request' required: true responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' description: Update a live input response failure '200': content: application/json: schema: $ref: '#/components/schemas/stream_live_input_response_single' description: Update a live input response security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Update a live input tags: - Stream Live Inputs x-api-token-group: - Stream Write /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs: get: description: Retrieves all outputs associated with a specified live input. operationId: stream-live-inputs-list-all-outputs-associated-with-a-specified-live-input parameters: - in: path name: live_input_identifier required: true schema: $ref: '#/components/schemas/stream_live_input_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' description: List all outputs associated with a specified live input response failure '200': content: application/json: schema: $ref: '#/components/schemas/stream_output_response_collection' description: List all outputs associated with a specified live input response security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform List all outputs associated with a specified live input tags: - Stream Live Inputs post: description: Creates a new output that can be used to simulcast or restream live video to other RTMP or SRT destinations. Outputs are always linked to a specific live input — one live input can have many outputs. operationId: stream-live-inputs-create-a-new-output,-connected-to-a-live-input parameters: - in: path name: live_input_identifier required: true schema: $ref: '#/components/schemas/stream_live_input_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/stream_create_output_request' required: true responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' description: Create a new output, connected to a live input response failure '200': content: application/json: schema: $ref: '#/components/schemas/stream_output_response_single' description: Create a new output, connected to a live input response security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Create a new output, connected to a live input tags: - Stream Live Inputs /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}: delete: description: Deletes an output and removes it from the associated live input. operationId: stream-live-inputs-delete-an-output parameters: - in: path name: output_identifier required: true schema: $ref: '#/components/schemas/stream_output_identifier' - in: path name: live_input_identifier required: true schema: $ref: '#/components/schemas/stream_live_input_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: content: application/json: {} required: true responses: 4XX: content: application/json: {} description: Delete an output response failure '200': content: application/json: {} description: Delete an output response security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Delete an output tags: - Stream Live Inputs put: description: Updates the state of an output. operationId: stream-live-inputs-update-an-output parameters: - in: path name: output_identifier required: true schema: $ref: '#/components/schemas/stream_output_identifier' - in: path name: live_input_identifier required: true schema: $ref: '#/components/schemas/stream_live_input_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/stream_update_output_request' required: true responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' description: Update an output response failure '200': content: application/json: schema: $ref: '#/components/schemas/stream_output_response_single' description: Update an output response security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Update an output tags: - Stream Live Inputs components: schemas: stream_output_response_collection: allOf: - $ref: '#/components/schemas/stream_api-response-common' - properties: result: items: $ref: '#/components/schemas/stream_output' type: array stream_create_input_request: properties: defaultCreator: $ref: '#/components/schemas/stream_live_input_default_creator' deleteRecordingAfterDays: $ref: '#/components/schemas/stream_live_input_recording_deletion' meta: $ref: '#/components/schemas/stream_live_input_metadata' recording: $ref: '#/components/schemas/stream_live_input_recording_settings' stream_playback_srt: description: Details for playback from an live input using SRT. properties: passphrase: $ref: '#/components/schemas/stream_playback_srt_stream_passphrase' streamId: $ref: '#/components/schemas/stream_playback_srt_stream_id' url: $ref: '#/components/schemas/stream_playback_srt_url' type: object stream_live_input: description: Details about a live input. properties: created: $ref: '#/components/schemas/stream_live_input_created' deleteRecordingAfterDays: $ref: '#/components/schemas/stream_live_input_recording_deletion' meta: $ref: '#/components/schemas/stream_live_input_metadata' modified: $ref: '#/components/schemas/stream_live_input_modified' recording: $ref: '#/components/schemas/stream_live_input_recording_settings' rtmps: $ref: '#/components/schemas/stream_input_rtmps' rtmpsPlayback: $ref: '#/components/schemas/stream_playback_rtmps' srt: $ref: '#/components/schemas/stream_input_srt' srtPlayback: $ref: '#/components/schemas/stream_playback_srt' status: $ref: '#/components/schemas/stream_live_input_status' uid: $ref: '#/components/schemas/stream_live_input_identifier' webRTC: $ref: '#/components/schemas/stream_input_webrtc' webRTCPlayback: $ref: '#/components/schemas/stream_playback_webrtc' type: object stream_playback_webrtc: description: Details for playback from a live input using WebRTC. properties: url: $ref: '#/components/schemas/stream_playback_webrtc_url' type: object stream_live_input_status: description: The connection status of a live input. enum: - null - connected - reconnected - reconnecting - client_disconnect - ttl_exceeded - failed_to_connect - failed_to_reconnect - new_configuration_accepted nullable: true type: string stream_api-response-common: properties: errors: $ref: '#/components/schemas/stream_messages' messages: $ref: '#/components/schemas/stream_messages' success: description: Whether the API call was successful enum: - true example: true type: boolean required: - success - errors - messages type: object stream_live_input_identifier: description: A unique identifier for a live input. example: 66be4bf738797e01e1fca35a7bdecdcd maxLength: 32 type: string stream_update_input_request: properties: defaultCreator: $ref: '#/components/schemas/stream_live_input_default_creator' deleteRecordingAfterDays: $ref: '#/components/schemas/stream_live_input_recording_deletion' meta: $ref: '#/components/schemas/stream_live_input_metadata' recording: $ref: '#/components/schemas/stream_live_input_recording_settings' stream_messages: example: [] items: properties: code: minimum: 1000 type: integer message: type: string required: - code - message type: object uniqueItems: true type: array stream_playback_srt_url: description: The URL used to play live video over SRT. example: rtmps://live.cloudflare.com:443/live/ type: string stream_input_webrtc_url: description: The WebRTC URL you provide to the broadcaster, which they stream live video to. example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/publish type: string stream_live_input_response_collection: allOf: - $ref: '#/components/schemas/stream_api-response-common' - properties: result: properties: liveInputs: items: $ref: '#/components/schemas/stream_live_input_object_without_url' type: array range: description: The total number of remaining live inputs based on cursor position. example: 1000 type: integer total: description: The total number of live inputs that match the provided filters. example: 35586 type: integer type: object stream_playback_rtmps_stream_key: description: The secret key to use for playback via RTMPS. example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada type: string stream_output_enabled: default: true description: 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. example: true type: boolean stream_input_rtmps_url: description: The RTMPS URL you provide to the broadcaster, which they stream live video to. example: rtmps://live.cloudflare.com:443/live/ type: string stream_schemas-identifier: description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 type: string stream_input_rtmps: description: Details for streaming to an live input using RTMPS. properties: streamKey: $ref: '#/components/schemas/stream_input_rtmps_stream_key' url: $ref: '#/components/schemas/stream_input_rtmps_url' type: object stream_live_input_created: description: The date and time the live input was created. example: '2014-01-02T02:20:00Z' format: date-time type: string stream_live_input_recording_settings: description: 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. example: hideLiveViewerCount: false mode: 'off' requireSignedURLs: false timeoutSeconds: 0 properties: allowedOrigins: $ref: '#/components/schemas/stream_live_input_recording_allowedOrigins' hideLiveViewerCount: $ref: '#/components/schemas/stream_live_input_recording_hideLiveViewerCount' mode: $ref: '#/components/schemas/stream_live_input_recording_mode' requireSignedURLs: $ref: '#/components/schemas/stream_live_input_recording_requireSignedURLs' timeoutSeconds: $ref: '#/components/schemas/stream_live_input_recording_timeoutSeconds' type: object stream_api-response-single: allOf: - $ref: '#/components/schemas/stream_api-response-common' type: object stream_live_input_recording_deletion: description: 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. example: 45 minimum: 30 type: number stream_live_input_recording_timeoutSeconds: default: 0 description: 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. type: integer stream_live_input_recording_mode: default: 'off' description: 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. enum: - 'off' - automatic example: automatic type: string stream_live_input_modified: description: The date and time the live input was last modified. example: '2014-01-02T02:20:00Z' format: date-time type: string stream_playback_srt_stream_id: description: The identifier of the live input to use for playback via SRT. example: f256e6ea9341d51eea64c9454659e576 type: string stream_output_url: description: The URL an output uses to restream. example: rtmp://a.rtmp.youtube.com/live2 type: string stream_live_input_recording_requireSignedURLs: default: false description: 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. example: true type: boolean stream_playback_rtmps_url: description: The URL used to play live video over RTMPS. example: rtmps://live.cloudflare.com:443/live/ type: string stream_input_srt_stream_id: description: The identifier of the live input to use when streaming via SRT. example: f256e6ea9341d51eea64c9454659e576 type: string stream_update_output_request: properties: enabled: $ref: '#/components/schemas/stream_output_enabled' required: - enabled stream_output_response_single: allOf: - $ref: '#/components/schemas/stream_api-response-single' - properties: result: $ref: '#/components/schemas/stream_output' stream_playback_rtmps: description: Details for playback from an live input using RTMPS. properties: streamKey: $ref: '#/components/schemas/stream_playback_rtmps_stream_key' url: $ref: '#/components/schemas/stream_playback_rtmps_url' type: object stream_live_input_metadata: description: A user modifiable key-value store used to reference other systems of record for managing live inputs. example: name: test stream 1 type: object stream_api-response-common-failure: properties: errors: allOf: - $ref: '#/components/schemas/stream_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/stream_messages' example: [] result: enum: - null nullable: true type: object success: description: Whether the API call was successful enum: - false example: false type: boolean required: - success - errors - messages - result type: object stream_playback_srt_stream_passphrase: description: The secret key to use for playback via SRT. example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada type: string stream_output_streamKey: description: The streamKey used to authenticate against an output's target. example: uzya-f19y-g2g9-a2ee-51j2 type: string stream_output: properties: enabled: $ref: '#/components/schemas/stream_output_enabled' streamKey: $ref: '#/components/schemas/stream_output_streamKey' uid: $ref: '#/components/schemas/stream_output_identifier' url: $ref: '#/components/schemas/stream_output_url' stream_playback_webrtc_url: description: The URL used to play live video over WebRTC. example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/play type: string stream_input_webrtc: description: Details for streaming to a live input using WebRTC. properties: url: $ref: '#/components/schemas/stream_input_webrtc_url' type: object stream_live_input_recording_hideLiveViewerCount: default: false description: Disables reporting the number of live viewers when this property is set to `true`. example: true type: boolean stream_input_srt_stream_passphrase: description: The secret key to use when streaming via SRT to a live input. example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada type: string stream_include_counts: default: false description: Includes the total number of videos associated with the submitted query parameters. example: true type: boolean stream_input_rtmps_stream_key: description: The secret key to use when streaming via RTMPS to a live input. example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada type: string stream_input_srt: description: Details for streaming to a live input using SRT. properties: passphrase: $ref: '#/components/schemas/stream_input_srt_stream_passphrase' streamId: $ref: '#/components/schemas/stream_input_srt_stream_id' url: $ref: '#/components/schemas/stream_input_srt_url' type: object stream_live_input_default_creator: description: Sets the creator ID asssociated with this live input. type: string stream_live_input_object_without_url: properties: created: $ref: '#/components/schemas/stream_live_input_created' deleteRecordingAfterDays: $ref: '#/components/schemas/stream_live_input_recording_deletion' meta: $ref: '#/components/schemas/stream_live_input_metadata' modified: $ref: '#/components/schemas/stream_live_input_modified' uid: $ref: '#/components/schemas/stream_live_input_identifier' stream_input_srt_url: description: The SRT URL you provide to the broadcaster, which they stream live video to. example: srt://live.cloudflare.com:778 type: string stream_output_identifier: description: A unique identifier for the output. example: baea4d9c515887b80289d5c33cf01145 maxLength: 32 type: string stream_create_output_request: properties: enabled: $ref: '#/components/schemas/stream_output_enabled' streamKey: $ref: '#/components/schemas/stream_output_streamKey' url: $ref: '#/components/schemas/stream_output_url' required: - url - streamKey stream_live_input_response_single: allOf: - $ref: '#/components/schemas/stream_api-response-single' - properties: result: $ref: '#/components/schemas/stream_live_input' stream_live_input_recording_allowedOrigins: description: 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. example: - example.com items: type: string type: array securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true