Operations related to live streams. A live stream is a single, linear video broadcast. You broadcast a live stream by receiving encoded source video into the Wowza Video service and letting Wowza Video transcode the stream and deliver it to viewers. A live stream is essentially a one-stop method for creating a transcoder, output renditions, stream targets, and associated players.
Wowza Video
/- Reference
- REST API
/
Delete a real-time stream
Wowza Video REST API Reference Documentation (v1.11)
API lifecycle phase: Supported 2
| Want to take the API for a test run? All you'll need is a Wowza Video subscription, or free trial, for the API access token. Then, fork our collection in Postman and you'll be making calls to our REST API in minutes! See Trial the Wowza Video REST API using Postman for more information. |
This reference documentation provides details about the operations, parameters, and request and reponse schemas for every resource and endpoint in the Wowza Video REST API. Samples appear in the right column. Sample requests are presented in cURL (Shell) and JavaScript; some samples also include just the JSON object. Response samples are all JSON. Examples in cURL use environment variables so you can easily copy and paste them. To learn more, see Using cURL.
Reference documentation is available for every version of the API. Use the Version menu at the top of the page to access the reference doc for a different version of the API.
Download OpenAPI description
Overview
License
Languages
Servers
Mock server
https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi
https://api.video.wowza.com/api/v1.11
Operations related to recordings, which are created through the /live_streams or /transcoders resources. The Wowza Video service can create MP4 recordings of your live streams and transcoded output. Recordings can be downloaded and saved locally. They're based on the highest-bitrate output rendition that Wowza Video generates from your video source. See About recordings to learn more.
Operations
Operations related to schedules. Schedules allow you to automatically start or stop a live stream or transcoder at a predetermined date and time. You can configure a schedule to start and/or stop a live stream or transcoder just once, or you can configure it to repeat the behavior on a regular basis. See About schedules to learn more.
Operations
Operations related to video on demand (VOD) streams, which are created through the /live_streams or /transcoders resources. A VOD stream is a recording of a live stream that viewers can replay at a later date. After the broadcast is over and the live stream or transcoder is stopped, Wowza Video creates the VOD stream and generates a playback URL. See About VOD Streams to learn more.
Operations
Operations related to Real-Time Streaming at Scale. If your audience is fewer than 300 viewers or you want to deliver a stream in near real time alongside other delivery protocols, use our WebRTC solution.
To enable and purchase capacity for Real-Time Streaming at Scale for your account and access the /real_time operations, contact 720.279.8163 or schedule a call.
Operations
Bodyapplication/jsonrequired
Provide the details of the real-time stream to update in the body of the request.
- Mock serverhttps://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/real_time/{id}
- https://api.video.wowza.com/api/v1.11/real_time/{id}
- curl
- Java
- Python
- JavaScript
curl -i -X PATCH \
'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/real_time/{id}' \
-H 'Content-Type: application/json' \
-d '{
"real_time_stream": {
"name": "MyUpdatedRealTimeStream"
}
}'Success
Example: {"id":"2adffc17","name":"MyRealTimeStream","stream_name":"8d304b93f1684320a54f2798666eeca7","token":"97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc","rtmp_url":"rtmp://rtmp-realtime1.wowza.com:1935/v2/pub/8d304b93f1684320a54f2798666eeca7?token=97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc","enable_secure_viewer":false,"state":"active","region":"amsterdam","recording":true,"disable_vod_encoder":true,"created_at":"2021-06-30T18:02:20.000Z","updated_at":"2021-06-30T20:03:16.000Z"}
The date and time that the real-time stream was created.
Example: "2021-06-30T18:02:20.000Z"
The unique identifier of the real-time stream. Use this ID to perform other operations on the stream, like getting the details of the stream or deleting it.
Example: "2adffc17"
A descriptive name for the real-time stream.
Example: "MyRealTimeStream"
The generated alphanumeric stream name you pass to the SDK.
Example: "8d304b93f1684320a54f2798666eeca7"
The authentication token you pass to the SDK.
Example: "97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc"
A secure token that must be passed by viewers for playback. Generated after you set enable_secure_viewer to true.
The URL you can use to configure an RTMP encoder as the source.
Example: "rtmp://rtmp-realtime1.wowza.com:1935/v2/pub/8d304b93f1684320a54f2798666eeca7?token=97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc"
The date and time the security token expires. Specify YYYY-MM-DD HH:MM:SS, where HH is a 24-hour clock in UTC. If you don't specify HH:MM:SS, the token expires at 12AM UTC on the specified day. Required when enable_secure_viewer is true.
The state of the stream.
Enum"active""archived""disabled""stopped"
Example: "active"
An option to set the regional server the stream is distributed through. Select the region closest to your broadcast location for the most reliable stream. If you select the auto option, Wowza Video selects the region based on the publisher's location.
Default: phoenix
Example: "region": amsterdam
Enum"phoenix""amsterdam""singapore""bangalore""auto"
Example: "amsterdam"
If true, records the real-time stream so you can download an MP4 later. The recording starts when the stream starts and stops automatically when the stream stops.
Recordings for real-time streams capture up to twelve hours of content in a single MP4 file. If the real-time stream recording is longer twelve hours, you'll have multiple files for the recording.
Default: false
Note: You can't update this value after you create the stream.
Example: "recording": true
Example: true
Skips VOD encoding and only creates an MP4 file for download. No VOD stream is created from the real-time stream.
Can only be set when recording is true and you can't change this value after you create the stream.
Default: false
Example: "disable_vod_encoder": true
Example: true
Response
application/json
{ "real_time_stream": { "id": "2adffc17", "name": "MyRealTimeStream", "stream_name": "8d304b93f1684320a54f2798666eeca7", "token": "97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc", "rtmp_url": "rtmp://rtmp-realtime1.wowza.com:1935/v2/pub/8d304b93f1684320a54f2798666eeca7?token=97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc", "enable_secure_viewer": false, "state": "active", "region": "amsterdam", "recording": true, "disable_vod_encoder": true, "created_at": "2021-06-30T18:02:20.000Z", "updated_at": "2021-06-30T20:03:16.000Z" } }
- Mock serverhttps://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/real_time/{id}
- https://api.video.wowza.com/api/v1.11/real_time/{id}
- curl
- Java
- Python
- JavaScript
curl -i -X DELETE \
'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/real_time/{id}'- Mock serverhttps://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/real_time/stop/{id}
- https://api.video.wowza.com/api/v1.11/real_time/stop/{id}
- curl
- Java
- Python
- JavaScript
curl -i -X PUT \
'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/real_time/stop/{id}'Response
application/json
{ "real_time_stream": { "state": "stopped" } }