openapi: 3.0.2 info: version: v2.0 title: Wowza Video REST API Reference Documentation license: name: Terms of Use url: https://www.wowza.com/legal/terms-of-use description: > API lifecycle phase: [Current](https://www.wowza.com/docs/wowza-video-rest-api-lifecycle-management#api-lifecycle0)
Want to take the API for a test run? All you'll need is a [Wowza Video subscription](https://www.wowza.com/pricing), or [free trial](https://www.wowza.com/free-trial), for the API access token. Then, fork [our collection in Postman](https://www.postman.com/wowzavideo/workspace/wowza-video-rest-api) and you'll be making calls to our REST API in minutes! See [Trial the Wowza Video REST API using Postman](https://www.wowza.com/docs/trial-the-wowza-video-rest-api-using-postman) for more information.
This reference documentation provides details about the operations, parameters, and request and response 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](https://wowza.com/docs/how-to-use-the-wowza-video-rest-api#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.
Note: If you haven't moved over to the new Wowza Video UI experience, you won't be able to access v2.0 of the API. We're migrating customers iteratively. See Upgrade to the Wowza Video 2.0 REST API for more information.
servers: - url: https://api.video.wowza.com/api/v2.0 tags: - name: live_streams description: >- 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. x-displayName: Live Streams - name: players description: >-
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
Operations related to players, which are created through the ``/live_streams`` resource. Players created through Wowza Video live streams can be embedded into your own web page or played through a web page hosted by Wowza Video. x-displayName: Players - name: assets description: >-
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
Operations related to assets, which are created through the ``/assets`` resources. The Wowza Video service can store and transcode mp4 files that you can tag, manage, and restream. x-displayName: Assets - name: recordings description: >-
The recordings operations are deprecated in 2.0. Use the /videos endpoints instead.
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](https://www.wowza.com/docs/record-live-streams-and-transcoders#aboutREC) to learn more. x-displayName: Recordings - name: schedules description: >- 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](https://www.wowza.com/docs/schedule-live-streams-and-transcoders#aboutSCH) to learn more. x-displayName: Schedules - name: stream_sources description: >- Operations related to stream sources. You can create a Wowza stream source and associate it to a live stream or transcoder. ### Wowza Stream Sources When you set up a Wowza stream source with a live stream or transcoder, Wowza Video can automatically detect broadcast location, automatically start a stream when the video source starts, and automatically stop a stream after the video source disconnects. x-displayName: Stream Sources - name: stream_targets description: >- Operations related to stream targets. A stream target is a destination for a stream. Stream targets can be Wowza Video edge resources; custom, external destinations, target destinations. ### Wowza CDN Stream Targets Wowza CDN stream targets distribute streams to players. When you create a live stream in the API, a Wowza CDN stream target is created automatically. In contrast, you can use ``/stream_targets/wowza_cdn`` endpoints to manually create Wowza CDN stream targets and associate them with transcoders. With Wowza CDN stream targets, you can use geo-blocking to control locations where your stream can be viewed, and you can use token authentication to restrict access to streams. Advanced configuration properties are available for Wowza CDN stream targets. ### Custom Stream Targets Custom stream targets connect to external CDNs to deliver streams to viewers. You manually create custom stream targets and associate them to a transcoder. x-displayName: Stream Targets - name: transcoders description: >- Operations related to transcoders, output renditions, and output stream targets. ### Transcoders Wowza Video transcoders allow you to customize transcoding processes by creating transcoders that are optimized for various network or streaming conditions. When you create a transcoder through the ``/transcoders`` endpoint, you must manually configure output renditions and associated output stream targets. Transcoders, like live streams, can be adaptive bitrate or passthrough. An adaptive bitrate transcoder generates multiple output renditions of your live stream, at different bitrates. A passthrough transcoder, in contrast, sends the source video to a stream target without performing transcoding. Passthrough transcoders, which can only be created if you have a subscription plan that supports them, accrue processing time, bandwidth, and egress usage, but much less than their adaptive bitrate counterparts. ### Output Renditions Before you can start an adaptive bitrate transcoder, you must use the ``/transcoders/{transcoder_id}/outputs`` operations to define the adaptive bitrate output renditions that you want the transcoder to create. Passthrough transcoders require only one output rendition because they send source video to a stream target without transcoding. ### Output Stream Targets Transcoders require output stream targets before you can start them. Although you create and configure stream targets using the different ``/stream_targets`` operations, you must associate a stream target to a transcoder's output rendition using the /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets operations. For an adaptive bitrate transcoder with multiple output renditions defined, you must create output stream targets to associate a stream target to each output rendition. For a passthrough transcoder, you only need one output stream target. x-displayName: Transcoders - name: vod_streams description: >-
The VOD stream operations are deprecated in 2.0. Use the /videos endpoints instead.
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](https://www.wowza.com/docs/create-a-vod-stream#about-vod-streams) to learn more. x-displayName: VOD Streams - name: real_time description: >- 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.
x-displayName: Real-Time Streams - name: usage description: >- Operations related to stream target analytics, including CDN usage and viewer data. x-displayName: Stream Targets - name: usage_transcoders description: Operations related to transcoder analytics. x-displayName: Transcoders - name: usage_live_streams description: Operations related to livestream analytics. x-displayName: Livestreams - name: storage description: |-
The storage operations are deprecated in 2.0. Operations related to peak and current storage for an account. x-displayName: Storage - name: usage_vod_streams description: >-
The VOD stream operations are deprecated in 2.0. Operations related to video on demand (VOD) stream analytics. x-displayName: VOD Streams (Usage) - name: usage_real_time_streams description: Operations related to real-time streams analytics. x-displayName: Real Time Streams - name: usage_account description: Operations related to stream analytics for an account. x-displayName: Account - name: analytics_viewers description: Operations related to viewer analytics. x-displayName: Viewers - name: analytics_ingest description: Operations related to ingest analytics for a live stream. x-displayName: Ingest - name: analytics_engagement description: Operations related to engagement analytics for a VOD stream. x-displayName: Engagement - name: analytics_popularity description: Operations related to popularity analytics. x-displayName: Popularity - name: quality_of_experience description: Operations related to quality of experience metrics. x-displayName: Quality of Experience - name: videos description: Operations related to uploading and categorizing videos. x-displayName: Videos - name: categories description: Operations related to categorizing videos. x-displayName: Categories - name: advanced_token_authentication description: >- Operations related to using advanced token authentication, known in Wowza Video as a default playback token behavior option, with videos. Use token authentication when distributing valuable or sensitive video content to audiences to ensure that only authorized users can access the content within the intended application. This allows for protection of intellectual property, compliance with regulations, and the ability to maintain control over content distribution. The token is embedded in the videos' embed URLs. Through the UI or Wowza Video API, you can choose one of the following options for token authentication of a video: - **NO_TOKEN** - Video files are accessible and can be downloaded and played by anyone at any time. This is the default. - **BASIC_TOKEN** - The platform automatically creates tokenized video URLs. This setting makes it hard for a viewer to extract the video URL and store it for usage in unintended applications over time since the embed URL, which has the token as part of the URL, will only be playable for 48 hours. The token auto renews after 48 hours when used in the intended application. - **ADVANCED_TOKEN** - You add the stream's JS embed code (Share Stream) and a token to your site to provide tokenization. The protections are similar to those for the Basic Token option except you customize the time limit, geographical limits, etc. during token creation. - **FOLLOW_DEFAULT:** - The token behavior is based on the **Default Playback Token Behavior** setting you selected for your Wowza account. See the Org Settings page in Wowza Video article for where to set this configuration. **Note:** You'll use the /videos endpoints to update and review the token authentication enums bulleted above. Before selecting to use the **ADVANCED_TOKEN**, you must, first, either: - Generate a key id via the Wowza Video API, then customize and generate a token via the Wowza Video 2.0 API to add to your site. You'll need the key id to create and sign the token. - Generate a key id and key via the Wowza Video 2.0 API, then customize and generate a standard common access token (CAT) through the means you usually use to create tokens to add to your site. You'll need the key id and key to create and sign the token. After you have your playback token, you add the video JS-embed and the playback token to your site if you're going to use the **ADVANCED_TOKEN** option. The JS-embed code automatically adds the player and related video to your site. See the section on how to embed the player and video". x-displayName: Advanced Token Authentication - name: clipping description: Operations related to clipping and stitching videos and live streams. x-displayName: Clipping paths: /live_streams: post: summary: Create a live stream description: This operation creates a live stream. operationId: createLiveStream tags: - live_streams x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "POST" \ "${WV_HOST}/api/v2.0/live_streams" \ -d $'{ "live_stream": { "name": "My New Live Stream", "transcoder_type": "transcoded", "billing_mode": "pay_as_you_go", "broadcast_location": "us_west_california", "encoder": "other_rtmp", "delivery_method": "push", "aspect_ratio_width": 1920, "aspect_ratio_height": 1080 } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/live_streams'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'POST', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "live_stream": { "name": "My New Live Stream", "transcoder_type": "transcoded", "billing_mode": "pay_as_you_go", "broadcast_location": "us_west_california", "encoder": "other_rtmp", "delivery_method": "push", "aspect_ratio_width": 1920, "aspect_ratio_height": 1080 } })); req.end(); requestBody: content: application/json: schema: $ref: '#/components/schemas/live_stream_create_input' description: >- Provide the details of the live stream to create in the body of the request. required: true responses: '201': description: Success content: application/json: schema: type: object required: - live_stream properties: live_stream: $ref: '#/components/schemas/live_stream' example: aspect_ratio_height: 720 aspect_ratio_width: 1280 billing_mode: pay_as_you_go broadcast_location: us_west_california closed_caption_type: cea connection_code: 0e15cb connection_code_expires_at: '2020-11-30T17:16:21.956Z' created_at: '2020-01-29T17:16:21.956Z' delivery_method: push delivery_protocols: - rtmp - rtsp - wowz - webrtc description: This is my first live stream. direct_playback_urls: rtmp: - name: source url: >- rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789 - name: webrtc output_id: dcxq5q6c url: >- rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream1 - name: V:1280x720+A:128K output_id: 0g116zkf url: >- rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream2 - name: V:854x480+A:128K output_id: 4qqkwndt url: >- rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream3 - name: V:640x360+A:128K output_id: 0pv8djpg url: >- rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream4 - name: V:512x288+A:128K output_id: b09xrxjf url: >- rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream5 - name: V:320x180+A:128K output_id: bvkh2nsz url: >- rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream6 rtsp: - name: source url: >- rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789 - name: webrtc output_id: dcxq5q6c url: >- rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1 - name: V:1280x720+A:128K output_id: 0g116zkf url: >- rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2 - name: V:854x480+A:128K output_id: 4qqkwndt url: >- rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3 - name: V:640x360+A:128K output_id: 0pv8djpg url: >- rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4 - name: V:512x288+A:128K output_id: b09xrxjf url: >- rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5 - name: V:320x180+A:128K output_id: bvkh2nsz url: >- rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6 wowz: - name: source url: >- wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789 - name: webrtc output_id: dcxq5q6c url: >- wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1 - name: V:1280x720+A:128K output_id: 0g116zkf url: >- wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2 - name: V:854x480+A:128K output_id: 4qqkwndt url: >- wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3 - name: V:640x360+A:128K output_id: 0pv8djpg url: >- wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4 - name: V:512x288+A:128K output_id: b09xrxjf url: >- wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5 - name: V:320x180+A:128K output_id: bvkh2nsz url: >- wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6 webrtc: - name: source url: >- wss://abc123.entrypoint.video.wowza.com/webrtc-session.json application_name: app-B8P6K226 stream_name: 1722aead - name: webrtc output_id: dcxq5q6c url: >- wss://abc123.entrypoint.video.wowza.com/webrtc-session.json application_name: app-B8P6K226 stream_name: 1722aead_stream1 - name: V:1280x720+A:128K output_id: 0g116zkf url: >- wss://abc123.entrypoint.video.wowza.com/webrtc-session.json application_name: app-B8P6K226 stream_name: 1722aead_stream2 - name: V:854x480+A:128K output_id: 4qqkwndt url: >- wss://abc123.entrypoint.video.wowza.com/webrtc-session.json application_name: app-B8P6K226 stream_name: 1722aead_stream3 - name: V:640x360+A:128K output_id: 0pv8djpg url: >- wss://abc123.entrypoint.video.wowza.com/webrtc-session.json application_name: app-B8P6K226 stream_name: 1722aead_stream4 - name: V:512x288+A:128K output_id: b09xrxjf url: >- wss://abc123.entrypoint.video.wowza.com/webrtc-session.json application_name: app-B8P6K226 stream_name: 1722aead_stream5 - name: V:320x180+A:128K output_id: bvkh2nsz url: >- wss://abc123.entrypoint.video.wowza.com/webrtc-session.json application_name: app-B8P6K226 stream_name: 1722aead_stream6 encoder: other_rtmp flowplayer: true hosted_page: enabled: true description: My Hosted Page Description logo_image_url: >- https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg sharing_icons: true title: My Hosted Page url: https://embed.flowplayer.com/hosted/default/e8dk5bf6 id: wdjfqvsv name: My PAYG Transcoded WSE Live Stream playback_stream_name: wxyz6789 player_id: 205b4e8-b160-43c2-868d-d88698a4e850 player_type: wowza_flowplayer_v2 embed_code: null hls_playback_url: >- https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8 logo_image_url: >- https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg logo_position: top-right video_poster_image_url: >- https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg width: 640 recording: true reference_id: mySystemID_01 save_asset: false security: force_ssl_playback: false geoblock_enabled: true geoblock_by_location: allow geoblock_country_codes: DE, US geoblock_ip_override: deny geoblock_ip_addresses: 77.12.34.567, 78.23.45.678 token_auth_enabled: false token_auth_playlist_only: false state: stopped stream_source_id: 5skrfpyf stream_targets: - id: klbmg2h8 - id: bnjtdmmc target_delivery_protocol: hls-https transcoder_type: transcoded updated_at: '2020-01-31T06:12:39.956Z' use_stream_source: true vod_stream: true watermark: true watermark_height: 80 watermark_image_url: >- https://prod.s3.amazonaws.com/uploads/transcoder/watermark_image/12345/4baa13.jpg watermark_opacity: 75 watermark_position: top-right watermark_width: 100 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' get: summary: Fetch all live streams description: >- This operation shows limited details for all of your live streams. For detailed information, fetch a single live stream. operationId: listLiveStreams tags: - live_streams x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/live_streams" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/live_streams'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/live_streams' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' /live_streams/{id}: get: summary: Fetch a live stream description: This operation shows the details of a specific live stream. operationId: showLiveStream tags: - live_streams x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/live_streams/2adffc17" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/live_streams/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the live stream. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - live_stream properties: live_stream: $ref: '#/components/schemas/live_stream' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' patch: summary: Update a live stream description: This operation updates a live stream. operationId: updateLiveStream tags: - live_streams x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PATCH" \ "${WV_HOST}/api/v2.0/live_streams/2adffc17" \ -d $'{ "live_stream": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/live_streams/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname', path: path, method: 'PATCH', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "live_stream": { "property": "My Value", "...": "..." } })); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the live stream. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/live_stream_update_input' description: >- Provide the details of the live stream to update in the body of the request. required: true responses: '200': description: Success content: application/json: schema: type: object required: - live_stream properties: live_stream: $ref: '#/components/schemas/live_stream' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' delete: summary: Delete a live stream description: >- This operation deletes a live stream, including all assigned outputs and targets.

Note: You can't remove live streams that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint. operationId: deleteLiveStream tags: - live_streams x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v2.0/live_streams/2adffc17" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/live_streams/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'DELETE', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { // no data being returned, just: 204 NO CONTENT console.log(res.statusCode); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the live stream. schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /live_streams/{id}/start: put: summary: Start a live stream description: This operation starts a live stream. operationId: startLiveStream tags: - live_streams x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/live_streams/2adffc17/start" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/live_streams/2adffc17/start'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PUT', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the live stream. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - live_stream properties: live_stream: type: object title: live_stream properties: state: type: string description: The state of the live stream. example: starting enum: - started - stopped - starting - stopping - resetting '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /live_streams/{id}/stop: put: summary: Stop a live stream description: This operation stops a live stream. operationId: stopLiveStream tags: - live_streams x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/live_streams/2adffc17/stop" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/live_streams/2adffc17/stop'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PUT', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the live stream. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - live_stream properties: live_stream: type: object title: live_stream properties: state: type: string description: The state of the live stream. example: stopped enum: - started - stopped - starting - stopping - resetting '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /live_streams/{id}/reset: put: summary: Reset a live stream description: This operation resets a live stream. operationId: resetLiveStream tags: - live_streams x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/live_streams/2adffc17/reset" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/live_streams/2adffc17/reset'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PUT', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the live stream. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - live_stream properties: live_stream: type: object title: live_stream properties: state: type: string description: The state of the live stream. example: resetting enum: - started - stopped - starting - stopping - resetting '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /live_streams/{id}/regenerate_connection_code: put: summary: Regenerate the connection code for a live stream description: This operation regenerates the connection code of a live stream. operationId: regenerateConnectionCodeLiveStream tags: - live_streams x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/live_streams/2adffc17/regenerate_connection_code" - lang: JavaScript source: > // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/live_streams/2adffc17/regenerate_connection_code'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PUT', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the live stream. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - live_stream properties: live_stream: type: object title: live_stream properties: connection_code: type: string description: >- A six-character, alphanumeric string that allows certain encoders, including Wowza Streaming Engine and the Wowza GoCoder app, to connect with Wowza Video. The code can be used once and expires 24 hours after it's created. example: 0cd2e8 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /live_streams/{id}/thumbnail_url: get: summary: Fetch the thumbnail URL of a live stream description: This operation shows the thumbnail URL of a started live stream. operationId: showLiveStreamThumbnailUrl tags: - live_streams x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/live_streams/2adffc17/thumbnail_url" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/live_streams/2adffc17/thumbnail_url'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the live stream. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - live_stream properties: live_stream: type: object title: live_stream properties: thumbnail_url: type: string description: The URL to receive the preview thumbnail. example: >- https://cloud.wowza.com/proxy/stats/?target=10.11.12.13&app=app-B8P6K226&stream=99b62146@130135.stream&media=json '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /live_streams/{id}/state: get: summary: Fetch the state of a live stream description: This operation shows the current state of a live stream. operationId: showLiveStreamState tags: - live_streams x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/live_streams/2adffc17/state" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/live_streams/2adffc17/state'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the live stream. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - live_stream properties: live_stream: type: object title: live_stream properties: ip_address: type: string description: >- The IP address of the live stream instance. If the live stream *state* is anything other than **started**, the *ip_address* is **0.0.0.0**. example: 0.0.0.0 state: type: string description: The state of the live stream. example: stopped enum: - started - stopped - starting - stopping - resetting '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /players: get: summary: Fetch all players description: >-
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
This operation shows limited details for all of your players. For detailed information, fetch a single player. operationId: listPlayers tags: - players x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/players" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/players'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/players' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' /players/{id}: get: summary: Fetch a player description: >-
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
This operation shows details of a specific player. operationId: showPlayer tags: - players x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/players/2adffc17" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/players/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the player. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - player properties: player: $ref: '#/components/schemas/player' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' patch: summary: Update a player description: >-
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
This operation updates a player. operationId: updatePlayer tags: - players x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PATCH" \ "${WV_HOST}/api/v2.0/players/2adffc17" \ -d $'{ "player": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/players/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname', path: path, method: 'PATCH', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "player": { "property": "My Value", "...": "..." } })); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the player. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/player_update_input' description: >- Provide the details of the player to update in the body of the request. required: true responses: '200': description: Success content: application/json: schema: type: object required: - player properties: player: $ref: '#/components/schemas/player' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /players/{id}/rebuild: post: summary: Rebuild player code description: >-
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
This operation rebuilds the player with the current configuration. operationId: requestPlayerRebuild tags: - players x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "POST" \ "${WV_HOST}/api/v2.0/players/2adffc17/rebuild" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/players/2adffc17/rebuild'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'POST', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the player. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - player properties: player: type: object title: player properties: state: type: string description: The state of the player. example: requested enum: - requested - already_requested - activated '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /players/{id}/state: get: summary: Fetch the state of a player description: >-
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
This operation shows the current state of a player. operationId: showPlayerState tags: - players x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/players/2adffc17/state" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/players/2adffc17/state'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the player. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - player properties: player: type: object title: player properties: state: type: string description: The state of the player. example: activated enum: - requested - activated '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /players/{player_id}/urls: post: summary: Create a player URL description: >-
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
This operation creates a new player URL. operationId: createPlayerUrl tags: - players x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "POST" \ "${WV_HOST}/api/v2.0/players/2adffc17/urls" \ -d $'{ "player": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/players/2adffc17/urls'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'POST', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "player": { "property": "My Value", "...": "..." } })); req.end(); parameters: - name: player_id in: path required: true description: The unique alphanumeric string that identifies the player. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/url_create_input' description: >- Provide the details of the player URL to create in the body of the request. required: true responses: '200': description: Success content: application/json: schema: type: object required: - url properties: url: $ref: '#/components/schemas/url' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' get: summary: Fetch all player URLs description: >-
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
This operation shows the details of all player URLs. operationId: listPlayerUrls tags: - players x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/players/2adffc17/urls" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/players/2adffc17/urls'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: player_id in: path required: true description: The unique alphanumeric string that identifies the player. schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/urls' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /players/{player_id}/urls/{id}: get: summary: Fetch a player URL description: >-
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
This operation shows the details of a player URL. operationId: showPlayerUrl tags: - players x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/players/2adffc17/urls/1acfg43d" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/players/2adffc17/urls/1acfg43d'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: player_id in: path required: true description: The unique alphanumeric string that identifies the player. schema: type: string - name: id in: path required: true description: The unique alphanumeric string that identifies the player URL. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - url properties: url: $ref: '#/components/schemas/url' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' patch: summary: Update a player URL description: >-
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
This operation updates a player URL. operationId: updatePlayerUrl tags: - players x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PATCH" \ "${WV_HOST}/api/v2.0/players/2adffc17/urls/1acfg43d" \ -d $'{ "player": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/players/2adffc17/urls/1acfg43d'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname', path: path, method: 'PATCH', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "player": { "property": "My Value", "...": "..." } })); req.end(); parameters: - name: player_id in: path required: true description: The unique alphanumeric string that identifies the player. schema: type: string - name: id in: path required: true description: The unique alphanumeric string that identifies the player URL. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/url_update_input' description: >- Provide the details of the player URL to update in the body of the request. required: true responses: '200': description: Success content: application/json: schema: type: object required: - url properties: url: $ref: '#/components/schemas/url' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' delete: summary: Delete a player URL description: >-
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
This operation deletes a player URL. operationId: deletePlayerUrl tags: - players x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v2.0/players/2adffc17/urls/1acfg43d" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/players/2adffc17/urls/1acfg43d'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'DELETE', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { // no data being returned, just: 204 NO CONTENT console.log(res.statusCode); }).on('error', function(e) { console.log(e.message); }); parameters: - name: player_id in: path required: true description: The unique alphanumeric string that identifies the player. schema: type: string - name: id in: path required: true description: The unique alphanumeric string that identifies the player URL. schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /assets: post: summary: Create an asset description: >-
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
This operation creates an asset. You can only upload MP4 format and H.264 and AAC encoded files. Any files with unsupported codecs are rejected. operationId: createAsset tags: - assets x-codeSamples: - lang: Shell source: |- // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "POST" \ "${WV_HOST}/api/v2.0/assets" \ -d $'{ "asset": { "name": "My New Asset" } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/assets'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'POST', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "asset": { "name": "My New Asset" } })); req.end(); requestBody: content: application/json: schema: $ref: '#/components/schemas/asset_create_input' description: Provide the details of the asset to create in the body of the request. required: true responses: '201': description: Success content: application/json: schema: type: object required: - asset properties: asset: $ref: '#/components/schemas/asset_create_output' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' get: summary: Fetch all assets description: >-
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
This operation shows limited details for all of your assets. For detailed information, fetch a single asset. operationId: listAssets tags: - assets x-codeSamples: - lang: Shell source: |- // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/assets" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/assets'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: filter in: query required: false description: >- Restricts the data that gets returned by filtering on one or more values associated with a field. For more information and examples, see the technical article [How to get filtered query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-filtered-query-results-with-the-wowza-video-rest-api). Example: **filter[0][field]=created_at&filter[0][gte]=2021-07-14T17:47:45.000Z** schema: type: string - name: query in: query required: false description: >- Restricts the data that gets returned by querying on one or more values associated with a set of fields. For more information and examples, see the technical article [How to get filtered query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-filtered-query-results-with-the-wowza-video-rest-api). Example: **sort_direction=desc&sort_column=created_at&per_page=30&state=completed&query=sample** schema: type: string - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/assets' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' /assets/{id}: get: summary: Fetch an asset description: >-
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
This operation shows the details of a specific asset. The fields returned vary depending on when you send this request. For example, if a resource hasn't been created yet during the processing state, you won't see **available_renditions** in the response. **Tip**: If your original upload URL expired and you need a new one for an asset, send this request and the response will contain a new upload URL. operationId: showAsset tags: - assets x-codeSamples: - lang: Shell source: |- // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/assets/2adffc17" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/assets/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the asset. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - asset properties: asset: $ref: '#/components/schemas/asset' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' patch: summary: Update an asset description: >-
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
This operation updates an asset. Assets must be uploaded and complete processing before they can be updated. The fields returned vary depending on when you send this request. For example, if a stream doesn't have unique viewer data, you won't see **unique_viewers** in the response. operationId: updateAsset tags: - assets x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PATCH" \ "${WV_HOST}/api/v2.0/assets/2adffc17" \ -d $'{ "asset": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/assets/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname', path: path, method: 'PATCH', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "asset": { "property": "My Value", "...": "..." } })); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the asset. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/asset_update_input' description: Provide the details of the asset to update in the body of the request. required: true responses: '200': description: Success content: application/json: schema: type: object required: - asset properties: asset: $ref: '#/components/schemas/asset_update_output' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Asset Not Available content: application/json: schema: $ref: '#/components/schemas/Error422_asset_not_available' delete: summary: Delete an asset description: >-
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
This operation deletes an asset, including all assigned outputs and targets. operationId: deleteAsset tags: - assets x-codeSamples: - lang: Shell source: |- curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v2.0/assets/2adffc17" - lang: JavaScript source: |- // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/assets/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'DELETE', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { // no data being returned, just: 204 NO CONTENT console.log(res.statusCode); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the asset. schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Asset Not Available content: application/json: schema: $ref: '#/components/schemas/Error422_asset_not_available' /assets/{id}/live_streams: post: summary: Restream an asset description: >-
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
This operation returns a live stream ID you can use to re-stream an uploaded asset. operationId: restreamAsset tags: - assets x-codeSamples: - lang: Shell source: |- // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "POST" \ "${WV_HOST}/api/v2.0/assets/2adffc17/live_streams" - lang: JavaScript source: |- // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/assets/2adffc17/live_streams'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the asset. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - live_stream properties: live_stream: $ref: '#/components/schemas/asset_restream' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Asset Not Available content: application/json: schema: $ref: '#/components/schemas/Error422_asset_not_available' /asset_tags: get: summary: Fetch all asset tags description: >-
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
This operation retrieves a list of all of the tags that have been used previously by an organization. operationId: asset_tags tags: - assets x-codeSamples: - lang: Shell source: |- // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/asset_tags" - lang: JavaScript source: |- // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/asset_tags'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/asset_tags' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' /assets/{id}/upload_completed: patch: summary: Report asset as uploaded description: >-
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
This operation reports that an asset was successfully uploaded to storage. operationId: reportUploadedAsset tags: - assets x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PATCH" \ "${WV_HOST}/api/v2.0/assets/2adffc17/upload_completed" \ -d $'{ "asset": { "file_size": "1570024", "duration": "9241" } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/assets/2adffc17/upload_completed'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname', path: path, method: 'PATCH', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "asset": { "file_size": 1570024, "duration": 9241 } })); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the asset. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/asset_report_uploaded_input' description: Provide the details of the asset to update in the body of the request. required: true responses: '200': description: Success content: application/json: schema: type: object required: - asset properties: asset: $ref: '#/components/schemas/asset_report_uploaded_output' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /assets/{id}/upload_failed: patch: summary: Report asset upload as failed description: >-
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
This operation reports that an asset uploaded to storage failed. You can only upload MP4 format and H.264 and AAC encoded files. Any files with unsupported codecs are rejected. operationId: reportUploadFailedAsset tags: - assets x-codeSamples: - lang: Shell source: |- // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PATCH" \ "${WV_HOST}/api/v2.0/assets/2adffc17/upload_failed" - lang: JavaScript source: |- // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/assets/2adffc17/upload_failed'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PATCH', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { // no data being returned, just: 204 NO CONTENT console.log(res.statusCode); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the asset. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/asset_report_upload_failed_input' description: Provide the details of the asset to update in the body of the request. required: true responses: '200': description: Success content: application/json: schema: type: object required: - asset properties: asset: $ref: '#/components/schemas/asset_report_upload_failed_output' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /recordings: get: summary: Fetch all recordings description: >-
The recordings operations are deprecated in 2.0. Use the /videos endpoints instead.
This operation shows limited details for all of your recordings. For detailed information, fetch a single recording. operationId: listRecordings tags: - recordings parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/recordings" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/recordings'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/recordings' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' /recordings/{id}: get: summary: Fetch a recording description: >-
The recordings operations are deprecated in 2.0. Use the /videos endpoints instead.
This operation shows the details of a specific recording. operationId: showRecording tags: - recordings x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/recordings/2adffc17" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/recordings/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the recording. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - recording properties: recording: $ref: '#/components/schemas/recording' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' delete: summary: Delete a recording description: >-
The recordings operations are deprecated in 2.0. Use the /videos endpoints instead.
This operation deletes a recording.

Note: You can't remove recordings that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint. operationId: deleteRecording tags: - recordings x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v2.0/recordings/2adffc17" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/recordings/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'DELETE', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { // no data being returned, just: 204 NO CONTENT console.log(res.statusCode); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the recording. schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /recordings/{id}/state: get: summary: Fetch the state of a recording description: >-
The recordings operations are deprecated in 2.0. Use the /videos endpoints instead.
This operation shows the current state of a recording. operationId: showRecordingState tags: - recordings x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/recordings/2adffc17/state" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/recordings/2adffc17/state'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the recording. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - recording properties: recording: type: object title: recording properties: state: type: string description: The state of the recording. example: completed enum: - uploading - converting - removing - completed - failed '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /schedules: post: summary: Create a schedule description: This operation creates a schedule. operationId: createSchedule tags: - schedules x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "POST" \ "${WV_HOST}/api/v2.0/schedules" \ -d $'{ "schedule": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/schedules'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'POST', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "schedule": { "property": "My Value", "...": "..." } })); req.end(); requestBody: content: application/json: schema: $ref: '#/components/schemas/schedule_create_input' description: >- Provide the details of the schedule to create in the body of the request. required: true responses: '201': description: Success content: application/json: schema: type: object required: - schedule properties: schedule: $ref: '#/components/schemas/schedule' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' get: summary: Fetch all schedules description: This operation shows the details of all of your schedules. operationId: listSchedules tags: - schedules parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/schedules" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/schedules'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/schedules' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' /schedules/{id}: get: summary: Fetch a schedule description: This operation shows the details of a specific schedule. operationId: showSchedule tags: - schedules x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/schedules/2adffc17" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/schedules/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the schedule. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - schedule properties: schedule: $ref: '#/components/schemas/schedule' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' patch: summary: Update a schedule description: This operation updates a schedule. operationId: updateSchedule tags: - schedules x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PATCH" \ "${WV_HOST}/api/v2.0/schedules/2adffc17" \ -d $'{ "schedule": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/schedules/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname', path: path, method: 'PATCH', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "schedule": { "property": "My Value", "...": "..." } })); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the schedule. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/schedule_update_input' description: >- Provide the details of the schedule to update in the body of the request. required: true responses: '200': description: Success content: application/json: schema: type: object required: - schedule properties: schedule: $ref: '#/components/schemas/schedule' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' delete: summary: Delete a schedule description: This operation deletes a schedule. operationId: deleteSchedule tags: - schedules x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v2.0/schedules/2adffc17" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/schedules/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'DELETE', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { // no data being returned, just: 204 NO CONTENT console.log(res.statusCode); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the schedule. schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /schedules/{id}/enable: put: summary: Enable a schedule description: This operation enables a schedule. operationId: enableSchedule tags: - schedules x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/schedules/2adffc17/enable" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/schedules/2adffc17/enable'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PUT', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the schedule. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - schedule properties: schedule: type: object title: schedule properties: state: type: string description: >- A schedule must be **enabled** to run. Specify **enabled** to run the schedule or **disabled** to turn off the schedule so that it doesn't run. example: enabled enum: - enabled - disabled - expired '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /schedules/{id}/disable: put: summary: Disable a schedule description: This operation disables a schedule. operationId: disableSchedule tags: - schedules x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/schedules/2adffc17/disable" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/schedules/2adffc17/disable'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PUT', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the schedule. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - schedule properties: schedule: type: object title: schedule properties: state: type: string description: >- A schedule must be **enabled** to run. Specify **enabled** to run the schedule or **disabled** to turn off the schedule so that it doesn't run. example: disabled enum: - enabled - disabled - expired '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /schedules/{id}/state: get: summary: Fetch the state of a schedule description: This operation shows the current state of a schedule. operationId: showScheduleState tags: - schedules x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/schedules/2adffc17/state" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/schedules/2adffc17/state'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the schedule. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - schedule properties: schedule: type: object title: schedule properties: state: type: string description: >- A schedule must be **enabled** to run. Specify **enabled** to run the schedule or **disabled** to turn off the schedule so that it doesn't run. example: enabled enum: - enabled - disabled - expired '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /stream_sources: get: summary: Fetch all stream sources description: >- This operation shows limited details for all of your stream sources. For detailed information, fetch a single stream source of the appropriate type. operationId: listStreamSources tags: - stream_sources parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/stream_sources" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_sources'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/stream_sources' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' /stream_sources/wowza: post: summary: Create a Wowza stream source description: >- (Available from version 1.4) This operation creates a Wowza stream source. A Wowza stream source enables automatic transcoder start, stop, and broadcast location detection. operationId: createWowzaStreamSource tags: - stream_sources x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "POST" \ "${WV_HOST}/api/v2.0/stream_sources/wowza" \ -d $'{ "stream_source_wowza": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_sources/wowza'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'POST', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "stream_source_wowza": { "property": "My Value", "...": "..." } })); req.end(); requestBody: content: application/json: schema: $ref: '#/components/schemas/wowza_stream_source_create_input' description: >- Provide the details of the stream source to add in the body of the request. required: true responses: '201': description: Success content: application/json: schema: type: object required: - stream_source_wowza properties: stream_source_wowza: $ref: '#/components/schemas/stream_source_wowza_create' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /stream_sources/wowza/{id}: get: summary: Fetch a Wowza stream source description: >- (Available from version 1.4) This operation shows details of a specific Wowza stream source. A Wowza stream source enables automatic transcoder start, stop, and broadcast location detection. operationId: showWowzaStreamSource tags: - stream_sources x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/stream_sources/wowza/2adffc17" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_sources/wowza/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: >- The unique alphanumeric string that identifies the Wowza stream source. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - stream_source_wowza properties: stream_source_wowza: $ref: '#/components/schemas/stream_source_wowza' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' patch: summary: Update a Wowza stream source description: >- (Available from version 1.4) This operation updates a Wowza stream source. A Wowza stream source enables automatic transcoder start, stop, and broadcast location detection. operationId: updateWowzaStreamSource tags: - stream_sources x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PATCH" \ "${WV_HOST}/api/v2.0/stream_sources/wowza/2adffc17" \ -d $'{ "stream_source_wowza": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_sources/wowza/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname', path: path, method: 'PATCH', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "stream_source_wowza": { "property": "My Value", "...": "..." } })); req.end(); parameters: - name: id in: path required: true description: >- The unique alphanumeric string that identifies the Wowza stream source. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/wowza_stream_source_update_input' description: >- Provide the details of the stream source to update in the body of the request. required: true responses: '200': description: Success content: application/json: schema: type: object required: - stream_source_wowza properties: stream_source_wowza: $ref: '#/components/schemas/wowza_stream_source_patch_response' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' delete: summary: Delete a Wowza stream source description: >- (Available from version 1.4) This operation deletes a Wowza stream source. operationId: deleteWowzaStreamSource tags: - stream_sources x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v2.0/stream_sources/wowza/2adffc17" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_sources/wowza/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'DELETE', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { // no data being returned, just: 204 NO CONTENT console.log(res.statusCode); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: >- The unique alphanumeric string that identifies the Wowza stream source. schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /stream_targets: get: summary: Fetch all stream targets description: >- This operation lists limited details for custom stream targets and Wowza CDN stream targets. For detailed information, fetch a single stream target of a specific type. operationId: listStreamTargets tags: - stream_targets parameters: - $ref: '#/components/parameters/assignable' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/stream_targets" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_targets'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/stream_targets' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' /stream_targets/{id}: get: summary: Fetch a stream target description: >- This operation shows the details of a specific stream target whether it be a Wowza CDN, custom, Facebook Live, or LinkedIn Live stream target. operationId: showStreamTarget tags: - stream_targets x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/stream_targets/2adffc17" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_targets/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the stream target. schema: type: string responses: '200': description: Success content: application/json: schema: type: object properties: stream_target_custom: $ref: '#/components/schemas/stream_target_custom' stream_target_wowza_cdn: $ref: '#/components/schemas/stream_target_fastly' stream_target_facebook: $ref: '#/components/schemas/stream_target_facebook' stream_target_linkedin: $ref: '#/components/schemas/stream_target_linkedin' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /stream_targets/custom: post: summary: Create a custom stream target description: >- This operation creates a custom stream target for an external, third-party destination. operationId: createCustomStreamTarget tags: - stream_targets x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "POST" \ "${WV_HOST}/api/v2.0/stream_targets/custom" \ -d $'{ "stream_target_custom": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_targets/custom'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'POST', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "stream_target_custom": { "property": "My Value", "...": "..." } })); req.end(); requestBody: content: application/json: schema: $ref: '#/components/schemas/custom_stream_target_create_input' description: >- Provide the details of the custom stream target to create in the body of the request. required: true responses: '201': description: Success content: application/json: schema: type: object properties: stream_target_custom: $ref: '#/components/schemas/stream_target_custom' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' get: summary: Fetch all custom stream targets description: >- This operation lists limited details for all of your custom stream targets. For detailed information, fetch a single custom stream target. operationId: listCustomStreamTargets tags: - stream_targets parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/stream_targets/custom" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_targets/custom'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/stream_targets_custom' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' /stream_targets/custom/{id}: get: summary: Fetch a custom stream target description: This operation shows the details of a specific custom stream target. operationId: showCustomStreamTarget tags: - stream_targets x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/stream_targets/custom/2adffc17" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_targets/custom/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: >- The unique alphanumeric string that identifies the custom stream target. schema: type: string responses: '200': description: Success content: application/json: schema: type: object properties: stream_target_custom: $ref: '#/components/schemas/stream_target_custom' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' patch: summary: Update a custom stream target description: This operation updates a custom stream target. operationId: updateCustomStreamTarget tags: - stream_targets x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PATCH" \ "${WV_HOST}/api/v2.0/stream_targets/custom/2adffc17" \ -d $'{ "stream_target_custom": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_targets/custom/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname', path: path, method: 'PATCH', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "stream_target_custom": { "property": "My Value", "...": "..." } })); req.end(); parameters: - name: id in: path required: true description: >- The unique alphanumeric string that identifies the custom stream target. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/custom_stream_target_update_input' description: >- Provide the details of the custom stream target to update in the body of the request. required: true responses: '200': description: Success content: application/json: schema: type: object properties: stream_target_custom: $ref: '#/components/schemas/custom_stream_target_patch_response' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' delete: summary: Delete a custom stream target description: >- This operation deletes a custom stream target.

Note: You can't remove stream targets that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint. operationId: deleteCustomStreamTarget tags: - stream_targets x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v2.0/stream_targets/custom/2adffc17" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_targets/custom/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'DELETE', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { // no data being returned, just: 204 NO CONTENT console.log(res.statusCode); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: >- The unique alphanumeric string that identifies the custom stream target. schema: type: string - name: force in: query required: false description: >- When `true`, forces a hard delete by first disconnecting the stream target from any associated transcoder and then deleting it. schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /stream_targets/wowza_cdn: post: summary: Create a Wowza CDN stream target description: >- (Available from version 1.4) This operation creates a Wowza CDN stream target to deliver your stream using the Wowza CDN. operationId: createFastlyStreamTarget tags: - stream_targets x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "POST" \ "${WV_HOST}/api/v2.0/stream_targets/wowza_cdn" \ -d $'{ "stream_target_wowza_cdn": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_targets/wowza_cdn'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'POST', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "stream_target_wowza_cdn": { "property": "My Value", "...": "..." } })); req.end(); requestBody: content: application/json: schema: $ref: '#/components/schemas/fastly_stream_target_create_input' description: >- Provide the details of the Wowza CDN stream target to create in the body of the request. required: true responses: '201': description: Success content: application/json: schema: type: object required: - stream_target_wowza_cdn properties: stream_target_wowza_cdn: $ref: '#/components/schemas/stream_target_fastly' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' get: summary: Fetch all Wowza CDN stream targets description: >- (Available from version 1.4) This operation lists limited details for all of your Wowza CDN stream targets. For detailed information, fetch a single target. operationId: listFastlyStreamTargets tags: - stream_targets parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/stream_targets/wowza_cdn" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_targets/wowza_cdn'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/stream_targets_fastly' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' /stream_targets/wowza_cdn/{id}: get: summary: Fetch a Wowza CDN stream target description: >- (Available from version 1.4) This operation shows the details of a specific Wowza CDN stream target. operationId: showFastlyStreamTarget tags: - stream_targets x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/stream_targets/wowza_cdn/2adffc17" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_targets/wowza_cdn/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the stream target. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - stream_target_wowza_cdn properties: stream_target_wowza_cdn: $ref: '#/components/schemas/stream_target_fastly' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' patch: summary: Update a Wowza CDN stream target description: >- (Available from version 1.4) This operation updates a Wowza CDN stream target. operationId: updateFastlyStreamTarget tags: - stream_targets x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PATCH" \ "${WV_HOST}/api/v2.0/stream_targets/wowza_cdn/2adffc17" \ -d $'{ "stream_target_wowza_cdn": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_targets/wowza_cdn/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname', path: path, method: 'PATCH', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "stream_target_wowza_cdn": { "property": "My Value", "...": "..." } })); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the stream target. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/fastly_stream_target_update_input' description: >- Provide the details of the Wowza CDN stream target to update in the body of the request. required: true responses: '200': description: Success content: application/json: schema: type: object required: - stream_target_wowza_cdn properties: stream_target_wowza_cdn: $ref: '#/components/schemas/fastly_stream_target_patch_response' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' delete: summary: Delete a Wowza CDN stream target description: >- (Available from version 1.4) This operation deletes a Wowza CDN stream target.

Note: You can't remove stream targets that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint. operationId: deleteFastlyStreamTarget tags: - stream_targets x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v2.0/stream_targets/wowza_cdn/2adffc17" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_targets/wowza_cdn/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'DELETE', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { // no data being returned, just: 204 NO CONTENT console.log(res.statusCode); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the stream target. schema: type: string - name: force in: query required: false description: >- When `true`, forces a hard delete by first disconnecting the stream target from any associated transcoder and then deleting it. schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /stream_targets/{id}/regenerate_connection_code: put: summary: Regenerate the connection code for any stream target description: >- This operation regenerates the connection code of any kind of stream target. operationId: regenerateConnectionCodeStreamTarget tags: - stream_targets x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/stream_targets/2adffc17/regenerate_connection_code" - lang: JavaScript source: > // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_targets/2adffc17/regenerate_connection_code'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PUT', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the stream target. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - stream_target properties: stream_target: type: object title: stream_target properties: connection_code: type: string description: >- A six-character, alphanumeric string that allows select encoders, such as Wowza Streaming Engine or the Wowza GoCoder app, to send an encoded stream to a stream target in Wowza Video. The code can be used once and expires 24 hours after it's created. example: 0cd2e8 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /stream_targets/{stream_target_id}/properties: post: summary: Configure a property for a stream target description: >- This operation configures a property for a stream target. The properties available will depend on the *provider* you are using and are noted in the key descriptions below. For example, if you are using the provider **Wowza CDN on Fastly**, look for that in the descriptions. For a comprehensive resource describing the use of advanced properties, see [Set advanced properties with the Wowza Video REST API](https://www.wowza.com/docs/how-to-set-advanced-properties-by-using-the-wowza-video-rest-api). operationId: createStreamTargetProperty tags: - stream_targets x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "POST" \ "${WV_HOST}/api/v2.0/stream_targets/2adffc17/properties" \ -d $'{ "property": { "key": "chunkSize", "section": "hls", "value": 6 } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_targets/2adffc17/properties'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'POST', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "property": { "key": "chunkSize", "section": "hls", "value": 6 } })); req.end(); parameters: - name: stream_target_id in: path required: true description: The unique alphanumeric string that identifies the stream target. schema: type: string requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/stream_target_property_create_input' - $ref: '#/components/schemas/stream_target_properties_create_input' description: >- Provide the details of the property or properties to configure in the body of the request. You must include either *property* or *properties* in the request as the root object. required: true responses: '200': description: Success content: application/json: schema: oneOf: - $ref: >- #/components/schemas/stream_target_property_create_input_repsonse - $ref: >- #/components/schemas/stream_target_properties_create_input_response '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' get: summary: Fetch all properties of a stream target description: >- This operation shows the details of all of the properties assigned to a specific stream target. The properties returned will depend on the *provider* you are using and are noted in the key descriptions below. For a comprehensive resource describing the use of advanced properties, see [Set advanced properties with the Wowza Video REST API](https://www.wowza.com/docs/how-to-set-advanced-properties-by-using-the-wowza-video-rest-api). operationId: listStreamTargetProperties tags: - stream_targets x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/stream_targets/2adffc17/properties" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_targets/2adffc17/properties'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: stream_target_id in: path required: true description: The unique alphanumeric string that identifies the stream target. schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/stream_target_properties' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /stream_targets/{stream_target_id}/properties/{id}: get: summary: Fetch a property of a stream target description: >- This operation shows the details of a specific property assigned to a specific stream target. The properties returned will depend on the *provider* you are using and are noted in the key descriptions below. For a comprehensive resource describing the use of advanced properties, see [Set advanced properties with the Wowza Video REST API](https://www.wowza.com/docs/how-to-set-advanced-properties-by-using-the-wowza-video-rest-api). operationId: showStreamTargetProperty tags: - stream_targets x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/stream_targets/2adffc17/properties/hls-chunkSize" - lang: JavaScript source: > // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_targets/2adffc17/properties/hls-chunkSize'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: stream_target_id in: path required: true description: The unique alphanumeric string that identifies the stream target. schema: type: string - name: id in: path required: true description: >- The unique string that identifies the stream target property. The string contains the *section* and the *key*, connected by a dash. For example, **hls-chunkSize**. schema: type: string responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/stream_target_property_create_input_repsonse '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' delete: summary: Delete a stream target property description: This operation removes a property from a stream target. operationId: deleteStreamTargetProperty tags: - stream_targets x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v2.0/stream_targets/2adffc17/properties/hls-chunkSize" - lang: JavaScript source: > // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/stream_targets/2adffc17/properties/hls-chunkSize'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'DELETE', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { // no data being returned, just: 204 NO CONTENT console.log(res.statusCode); }).on('error', function(e) { console.log(e.message); }); parameters: - name: stream_target_id in: path required: true description: The unique alphanumeric string that identifies the stream target. schema: type: string - name: id in: path required: true description: >- The unique string that identifies the stream target property. The string contains the *section* and the *key*, connected by a dash. For example, **hls-chunkSize**. schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders: post: summary: Create a transcoder description: This operation creates a transcoder. operationId: createTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "POST" \ "${WV_HOST}/api/v2.0/transcoders" \ -d $'{ "transcoder": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'POST', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "transcoder": { "property": "My Value", "...": "..." } })); req.end(); requestBody: content: application/json: schema: $ref: '#/components/schemas/transcoder_create_input' description: >- Provide the details of the transcoder to create in the body of the request. required: true responses: '201': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: $ref: '#/components/schemas/transcoder' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' get: summary: Fetch all transcoders description: >- This operation shows limited details for all of your transcoders. For detailed information, fetch a single transcoder. operationId: listTranscoders tags: - transcoders parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/transcoders" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/transcoders' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' /transcoders/{id}: get: summary: Fetch a transcoder description: This operation shows the details of a specific transcoder. operationId: showTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: $ref: '#/components/schemas/transcoder' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' patch: summary: Update a transcoder description: This operation updates a transcoder. operationId: updateTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PATCH" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17" \ -d $'{ "transcoder": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname', path: path, method: 'PATCH', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "transcoder": { "property": "My Value", "...": "..." } })); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/transcoder_update_input' description: >- Provide the details of the transcoder to update in the body of the request. required: true responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: $ref: '#/components/schemas/transcoder' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' delete: summary: Delete a transcoder description: >- This operation deletes a transcoder, including all of its assigned output renditions and stream targets.

Note: You can't remove transcoders that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint. operationId: deleteTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'DELETE', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { // no data being returned, just: 204 NO CONTENT console.log(res.statusCode); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{id}/enable_all_stream_targets: put: summary: Enable a transcoder's stream targets description: >- This operation enables all of the stream targets assigned to a specific transcoder. operationId: enableAllStreamTargetsTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/enable_all_stream_targets" - lang: JavaScript source: > // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/enable_all_stream_targets'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PUT', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder required: - stream_targets properties: stream_targets: type: object title: stream_targets properties: state: type: string description: The state of the transcoder's stream targets. example: enabled enum: - enabled - disabled '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{id}/disable_all_stream_targets: put: summary: Disable a transcoder's stream targets description: >- This operation disables all of the stream targets assigned to a specific transcoder. operationId: disableAllStreamTargetsTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/disable_all_stream_targets" - lang: JavaScript source: > // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/disable_all_stream_targets'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PUT', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder required: - stream_targets properties: stream_targets: type: object title: stream_targets properties: state: type: string description: The state of the transcoder's stream targets. example: enabled enum: - enabled - disabled '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{id}/start: put: summary: Start a transcoder description: This operation starts a transcoder. operationId: startTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/start" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/start'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PUT', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder properties: state: type: string description: The state of the transcoder. example: starting enum: - starting - stopping - started - stopped - resetting uptime_id: type: string description: >- The unique identifier associated with a specific uptime period of a transcoder. example: abcd1234 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{id}/stop: put: summary: Stop a transcoder description: This operation stops a transcoder. operationId: stopTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/stop" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/stop'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PUT', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder properties: state: type: string description: The state of the transcoder. example: starting enum: - starting - stopping - started - stopped - resetting uptime_id: type: string description: >- The unique identifier associated with a specific uptime period of a transcoder. example: abcd1234 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{id}/reset: put: summary: Reset a transcoder description: This operation resets a transcoder. operationId: resetTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/reset" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/reset'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PUT', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder properties: state: type: string description: The state of the transcoder. example: resetting enum: - starting - stopping - started - stopped - resetting '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{id}/start_recording: put: summary: Start recording description: >- This operation starts the recording of a transcoder after the transcoder has started. If you want the recording to start and stop automatically when you start or stop the transcoder instead, set _recording_ to **true** when you create a transcoder or update a transcoder. operationId: startTranscoderRecording tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/start_recording" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/start_recording'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PUT', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder properties: recording: type: object description: The recording for the transcoder. properties: state: type: string description: The state of video capture for the transcoder. example: started enum: - started - stopped '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{id}/stop_recording: put: summary: Stop recording description: >- This operation stops the recording of a transcoder before the transcoder has stopped. Wowza Video begins converting the recording to an MP4 file after the transcoder has stopped. You can use this operation to manually stop recording even if _recording_ is set to **true** on the transcoder, meaning the recording was automatically started at transcoder start. If you want the recording to start and stop automatically when you start and stop the transcoder, set _recording_ to **true** when you create a transcoder or update a transcoder and then don't use the manual stop recording operation. operationId: stopTranscoderRecording tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/stop_recording" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/stop_recording'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PUT', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder properties: recording: type: object description: The recording for the transcoder. properties: state: type: string description: The state of video capture for the transcoder. example: stopped enum: - started - stopped '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{id}/recordings: get: summary: Fetch a transcoder's recordings description: >-
Deprecated in 2.0.
This operation shows limited details of all of the recordings for a specific transcoder. For detailed information about a recording, use the recording ID to fetch a recording. operationId: listTranscoderRecordings tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/recordings" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/recordings'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - recordings properties: recordings: type: array description: >- Array of recordings of this transcoder. See /recordings for more details. items: $ref: '#/components/schemas/index_recordings' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{id}/schedules: get: summary: Fetch transcoder's schedules description: >- This operation shows the details of all of the schedules for a specific transcoder. operationId: listTranscoderSchedules tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/schedules" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/schedules'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - schedules properties: schedules: type: array description: >- Array of schedules of this transcoder. See /schedules for more details. items: $ref: '#/components/schemas/schedule' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{id}/thumbnail_url: get: summary: Fetch the thumbnail URL of a transcoder description: This operation shows the thumbnail URL of a started transcoder. operationId: showTranscoderThumbnailUrl tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/thumbnail_url" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/thumbnail_url'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder properties: thumbnail_url: type: string description: The URL to receive the preview thumbnail. example: >- https://cloud.wowza.com/proxy/stats/?target=10.11.12.13&app=app-B8P6K226&stream=99b62146@130135.stream&media=json '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{id}/state: get: summary: Fetch the state and uptime ID of a transcoder description: This operation shows the current state and uptime ID of a transcoder. operationId: showTranscoderState tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/state" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/state'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder properties: ip_address: type: string description: >- The IP address of the transcoder instance. If the transcoder *state* is anything other than **started**, the *ip_address* is **0.0.0.0**. example: 1.2.3.4 state: type: string description: The state of the transcoder. example: started enum: - starting - stopping - started - stopped - resetting uptime_id: type: string description: >- The unique identifier associated with a specific uptime period of a transcoder. example: abcd1234 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{id}/vod_streams: get: summary: Fetch all VOD streams for a transcoder description: >- (Available from version 1.5) This operation shows the details of all VOD streams associated to a specific transcoder. operationId: listTranscoderVODStreams tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/vod_streams" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/vod_streams'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/vod_streams' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{transcoder_id}/uptimes: get: summary: Fetch all uptime records for a transcoder description: >- This operation shows all of the uptime records for a specific transcoder. An *uptime record* identifies a specific transcoding session. operationId: indexUptimes tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/uptimes" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/uptimes'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/uptimes' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{transcoder_id}/uptimes/{id}: get: summary: Fetch an uptime record description: >- This operation shows the details of a specific uptime record for a specific transcoder. An *uptime record* identifies a transcoding session. operationId: showUptime tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/uptimes/1acfg43d" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/uptimes/1acfg43d'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: id in: path required: true description: The unique alphanumeric string that identifies the uptime record. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - uptime properties: uptime: $ref: '#/components/schemas/uptime' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{transcoder_id}/outputs: post: summary: Create an output description: >- This operation creates an output rendition for a specific transcoder. You can create up to 10 outputs per transcoder. operationId: createTranscoderOutput tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "POST" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs" \ -d $'{ "transcoder": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/outputs'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'POST', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "transcoder": { "property": "My Value", "...": "..." } })); req.end(); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/output_create_input' description: >- Provide the details of the output rendition to create in the body of the request. required: true responses: '201': description: Success content: application/json: schema: type: object required: - output properties: output: $ref: '#/components/schemas/output' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' get: summary: Fetch all outputs of a transcoder description: >- This operation shows the details of all of the output renditions of a specific transcoder. operationId: listTranscoderOutputs tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/outputs'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/outputs' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{transcoder_id}/outputs/{id}: get: summary: Fetch an output description: >- This operation shows the details of a specific output rendition for a specific transcoder. operationId: showTranscoderOutput tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - output properties: output: $ref: '#/components/schemas/output' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' patch: summary: Update an output description: This operation updates an output rendition. operationId: updateTranscoderOutput tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PATCH" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d" \ -d $'{ "transcoder": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname', path: path, method: 'PATCH', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "transcoder": { "property": "My Value", "...": "..." } })); req.end(); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/output_update_input' description: >- Provide the details of the output rendition to update in the body of the request. required: true responses: '200': description: Success content: application/json: schema: type: object required: - output properties: output: $ref: '#/components/schemas/output' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' delete: summary: Delete an output description: This operation deletes an output, including all of its assigned targets. operationId: deleteTranscoderOutput tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'DELETE', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { // no data being returned, just: 204 NO CONTENT console.log(res.statusCode); }).on('error', function(e) { console.log(e.message); }); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets: post: summary: Create an output stream target description: >- This operation creates an output stream target, assigning the stream target to the specified output rendition. operationId: createTranscoderOutputOutputStreamTarget tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "POST" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets" \ -d $'{ "transcoder": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: > // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'POST', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "transcoder": { "property": "My Value", "...": "..." } })); req.end(); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: output_id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/output_stream_target_create_input' description: >- Provide the details of the output stream target to create in the body of the request. required: true responses: '201': description: Success content: application/json: schema: type: object required: - output_stream_target properties: output_stream_target: $ref: '#/components/schemas/output_stream_target' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' get: summary: Fetch all output stream targets of an output of a transcoder description: >- This operation shows the details of all of the output stream targets of an output of a transcoder. operationId: listTranscoderOutputOutputStreamTargets tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets" - lang: JavaScript source: > // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: output_id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/output_stream_targets' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}: get: summary: Fetch an output stream target description: This operation shows the details of an output stream target. operationId: showTranscoderOutputOutputStreamTarget tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77" - lang: JavaScript source: > // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: output_id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string - name: stream_target_id in: path required: true description: >- The unique alphanumeric string that identifies the stream target. **Tip:** If you're using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target. schema: type: string responses: '200': description: Success content: application/json: schema: type: object properties: output_stream_target: $ref: '#/components/schemas/output_stream_target' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' patch: summary: Update an output stream target description: This operation updates an output stream target. operationId: updateTranscoderOutputOutputStreamTarget tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PATCH" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77" \ -d $'{ "transcoder": { "property": "My Value", "...": "..." } }' - lang: JavaScript source: > // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname', path: path, method: 'PATCH', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "transcoder": { "property": "My Value", "...": "..." } })); req.end(); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: output_id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string - name: stream_target_id in: path required: true description: >- The unique alphanumeric string that identifies the stream target. **Tip:** If you're using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/output_stream_target_update_input' description: >- Provide the details of the output stream target to update in the body of the request. required: true responses: '200': description: Success content: application/json: schema: type: object required: - output_stream_target properties: output_stream_target: $ref: '#/components/schemas/output_stream_target' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' delete: summary: Delete an output stream target description: >- This operation deletes an output stream target, including all of its assigned targets. operationId: deleteTranscoderOutputOutputStreamTarget tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77" - lang: JavaScript source: > // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'DELETE', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { // no data being returned, just: 204 NO CONTENT console.log(res.statusCode); }).on('error', function(e) { console.log(e.message); }); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: output_id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string - name: stream_target_id in: path required: true description: >- The unique alphanumeric string that identifies the stream target. **Tip:** If you're using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target. schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}/enable: put: summary: Enable an output stream target description: This operation enables an output stream target. operationId: enableTranscoderOutputOutputStreamTarget tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/enable" - lang: JavaScript source: > // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/enable'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PUT', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: output_id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string - name: stream_target_id in: path required: true description: >- The unique alphanumeric string that identifies the stream target. **Tip:** If you're using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - stream_target properties: stream_target: type: object title: stream_target properties: state: type: string description: The state of the output stream target. example: enabled enum: - enabled - disabled - restarted '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}/disable: put: summary: Disable an output stream target description: This operation disables an output stream target. operationId: disableTranscoderOutputOutputStreamTarget tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/disable" - lang: JavaScript source: > // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/disable'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PUT', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: output_id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string - name: stream_target_id in: path required: true description: >- The unique alphanumeric string that identifies the stream target. **Tip:** If you're using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - stream_target properties: stream_target: type: object title: stream_target properties: state: type: string description: The state of the output stream target. example: disabled enum: - enabled - disabled - restarted '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}/restart: put: summary: Restart an output stream target description: This operation restarts an output stream target. operationId: restartTranscoderOutputOutputStreamTarget tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/restart" - lang: JavaScript source: > // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/restart'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'PUT', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.end(); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: output_id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string - name: stream_target_id in: path required: true description: >- The unique alphanumeric string that identifies the stream target. **Tip:** If you're using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - stream_target properties: stream_target: type: object title: stream_target properties: state: type: string description: The state of the output stream target. example: restarted enum: - enabled - disabled - restarted '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{transcoder_id}/properties: post: summary: Configure a property for a transcoder description: >- This operation configures a single property or an array of properties for a transcoder. For a comprehensive resource describing the use of advanced properties, see [Set advanced properties with the Wowza Video REST API](https://www.wowza.com/docs/how-to-set-advanced-properties-by-using-the-wowza-video-rest-api). operationId: createTranscoderProperty tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "POST" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/properties" \ -d $'{ "property": { "key": "rtpIgnoreProfileLevelId", "section": "rtsp", "value": true } }' - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/properties'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'POST', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; const req = https.request(options, function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); req.write(JSON.stringify({ "property": { "key": "rtpIgnoreProfileLevelId", "section": "rtsp", "value": true } })); req.end(); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string requestBody: content: application/json: schema: required: - property - properties oneOf: - $ref: '#/components/schemas/transcoder_property_create_input' - $ref: '#/components/schemas/transcoder_properties_create_input' description: >- Provide the details of the property or properties to configure in the body of the request. You must include either *property* or *properties* in the request as the root object. required: true responses: '200': description: Success content: application/json: schema: required: - property - properties oneOf: - $ref: >- #/components/schemas/transcoder_configure_property_post_response - $ref: >- #/components/schemas/transcoder_configure_properties_post_response '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' get: summary: Fetch a transcoder's properties description: This operation shows all of the properties of a specific transcoder. operationId: listTranscoderProperties tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/properties" - lang: JavaScript source: | // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/properties'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/transcoder_configure_properties_post_response '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{transcoder_id}/properties/{id}: get: summary: Fetch a property for a transcoder description: >- This operation shows the details of a specific property for a specific transcoder. operationId: showTranscoderProperty tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/properties/rtsp-rtpIgnoreProfileLevelId" - lang: JavaScript source: > // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/properties/rtsp-rtpIgnoreProfileLevelId'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { var body = ''; res.on('data', function(data){ body += data; }); res.on('end', function() { console.log(JSON.parse(body)); }); }).on('error', function(e) { console.log(e.message); }); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: id in: path required: true description: >- The unique string that identifies the transcoder property. The string contains the section and the key, connected by a dash. For example, **cupertino-aes128Secret**. schema: type: string responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/transcoder_configure_property_post_response '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' delete: summary: Delete a transcoder's property description: This operation deletes a specific property from a specific transcoder. operationId: deleteTranscoderProperty tags: - transcoders x-codeSamples: - lang: Shell source: | // Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v2.0/transcoders/2adffc17/properties/cupertino-aes128Secret" - lang: JavaScript source: > // Using Node.js const https = require('https'); const crypto = require('crypto'); var hostname = 'api.video.wowza.com' var path = '/api/v2.0/transcoders/2adffc17/properties/cupertino-aes128Secret'; //For security, never reveal API token in client-side code var wvJWT = 'Bearer [your JWT]'; const options = { hostname: hostname, path: path, method: 'DELETE', headers: { 'Authorization': wvJWT, 'Content-Type': 'application/json' } }; https.get(options, function(res) { // no data being returned, just: 204 NO CONTENT console.log(res.statusCode); }).on('error', function(e) { console.log(e.message); }); parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: id in: path required: true description: >- The unique string that identifies the transcoder property. The string contains the section and the key, connected by a dash. For example, **cupertino-aes128Secret**. schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /analytics/viewers/account: get: summary: Fetch viewer analytics data for an account description: >- (Available from version 1.11) This operation returns live and historic viewer data for the account related to the JSON web token used for API authentication. You'll use the query parameters to return live vs historic data, as well as specific types of viewer data. **Querying live data** 1. To get data for currently live streams, do not send **from** and **to** values. 2. Use the **include** query parameter to specify what data you want to return, including: countries, renditions, devices, and trend data. If you don't send any query parameters (to, from, or include), the total number of viewers is returned. **Querying historic data** 1. To get data for streams that ran previously, send **from** and **to** values. 2. Use the **include** query parameter to specify what data you want to return, including: countries, renditions, devices, and trend data. If you don't send **include** values, the total number of viewers is returned. If the time range between **from** and **to** query parameters is: