DriversRecommendedOutdated drivers can make a good PC feel brokenScan driver issues before chasing fixes manually.Scan NowOctober DealsAmazon USOctober deal check: compare before you payAmazon US: current deals, useful picks and tech finds.Check DealsWindows FixRecommendedWindows errors stealing your time? Find the fix fastScan stability, cleanup and performance issues.Fix Now×
Skip to content
VGSources
API

How to Use the Wowza Streaming Engine REST API

A practical guide to building Wowza Streaming Engine REST API requests, choosing documented endpoints and methods, authenticating securely, and troubleshooting errors.

By VGSources Team 6 min read
Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Use Wowza Streaming Engine’s REST API by sending an HTTP request to your server on port 8087, under the /v2/ route, with the method, headers, credentials, and resource path required by the operation. For example, a local server’s base URL is http://localhost:8087/v2/. Choose the exact endpoint in Wowza’s REST API reference; routes and supported methods vary by resource.

What the Wowza Streaming Engine REST API does

The REST API is an HTTP interface for configuring, managing, and monitoring Wowza Streaming Engine (WSE). It lets an administrator or developer automate operations that would otherwise be performed through management tools or server configuration. This article concerns the Streaming Engine API, not the separate Wowza Video cloud API.

A typical request combines a server address, a versioned route, an HTTP method, request headers, authentication, and—when the operation requires it—a JSON or XML body. The API reference identifies the available resources and their operations; do not assume that a method supported by one route is supported by another.

Build the request URL and choose the operation

URL pattern

Wowza documents this URL pattern: http://[your-wowza-server]:8087/v2/[path-to-resource]. Replace the server placeholder with the address or hostname of your WSE instance and the resource placeholder with the route from the API reference. The documented default port for REST requests is 8087; deployments can differ, so confirm the configured port and network access for your server.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
#1 Best Overall
Elebase USB to USB C Adapter for iPhone 18 Pro Max,USBC Car Charger Adapter
  • Read Before You Buy — No Video Output: These adapters support charging and USB 2.0 data transfer, but cannot transmit video signals. Except for standard USB webcams (which use USB data only), they are not compatible with HDMI/DisplayPort cables, video-capable USB-C hubs, or docking stations with video output.
  • Convert USB-A Ports to USB-C: Designed to connect USB-C earphones, cables, flash drives, card readers, and other USB-C accessories to standard USB-A ports. Plug-and-play with no drivers or software required.
  • Aluminum Alloy Housing: Built with a sturdy aluminum alloy shell that aids in heat dissipation and protects against daily wear and scratches. Designed to maintain a stable and secure connection.
  • Compact & Travel-Friendly: The ultra-compact design allows the adapter to stay plugged into your device without blocking adjacent ports or adding bulk, reducing wear and tear on your original USB ports.
  • 12-Month Warranty: Backed by a 12-month manufacturer warranty for peace of mind. Designed to meet strict quality control standards for reliable everyday performance.

Routes can include server, virtual-host, and application names. For example, application routes use the pattern /v2/servers/{serverName}/vhosts/{vhostName}/applications. The OpenAPI reference’s sample server is localhost:8087; its names and route parameters are examples, not values to copy blindly into another installation.

Match the HTTP method to the resource action

  • GET retrieves information.
  • POST creates records or submits data for an operation where that route documents POST.
  • PUT updates information or performs an action on an existing resource where documented.
  • DELETE removes a resource where documented.

These are general meanings, not a guarantee that every endpoint supports all four methods. Check the specific route and operation in the Wowza OpenAPI reference before sending a request.

Make a REST request

  1. Confirm access details. Identify the WSE server address, REST port, credentials, and the server, virtual-host, and application names used by the target resource.
  2. Find the endpoint. In the API reference, locate the resource and intended operation. Copy its path and required parameters rather than guessing.
  3. Set the method and content headers. Use the method documented for the operation. For JSON requests, the examples use Accept: application/json and Content-Type: application/json; charset=utf-8. Use XML media types instead if the operation and server configuration call for XML.
  4. Authenticate. Send credentials using an authentication method supported by the server’s configured mode and password encoding. A new installation uses basic authentication by default, according to Wowza’s overview.
  5. Send only the required body. Include a JSON or XML body for operations that require one; a retrieval request may not need a body. Follow the endpoint’s documented schema and required fields.
  6. Inspect the response. Check the HTTP status and response body, then verify the resulting state in WSE or by retrieving the resource. Avoid treating a successful request submission as proof that a separate streaming or delivery workflow is healthy.

A generic curl request has this shape; replace the placeholders and adapt the body to the endpoint schema:

Rank #2
Anker USB-C Hub, 5-in-1 USB Hub for Laptops, 4K HDMI Multiport Adapter
  • 5-in-1 USB-C Hub: Experience comprehensive connectivity featuring a Power Delivery input, two USB-A 2.0 ports, a USB-A 3.0 port, and an HDMI port. (Note: The USB-C power delivery input port is only for connecting an external wall charger to power your laptop and cannot power peripheral devices.)
  • 90W Pass-Through Charging: Achieve optimal charging with 90W pass-through power to your laptop, supported by a total input of 100W, with the hub reserving 10W for operational efficiency. (Note: Wall charger not included.)
  • Quick Data Transfers: Accelerate your productivity with rapid data transfers using a high-speed 5Gbps USB 3.0 port and two 480Mbps USB 2.0 ports.
  • 4K HDMI Display: Enhance your visual experience with a hub capable of delivering 4K resolution at 30Hz in both mirror and extend modes. Please note that this hub is compatible with MacBook (macOS 12 and newer), Windows 10 and 11, ChromeOS, and laptops equipped with DP Alt Mode and Power Delivery. Note: This device is not compatible with Linux.
  • What You Get: Anker USB-C Hub (5-in-1, 4K HDMI), welcome guide, 18-month warranty, and our friendly customer service.

curl -X GET "http://localhost:8087/v2/[path-to-resource]" -H "Accept: application/json" -u "[username]:[password]"

Free tools Windows power users keep installed

One-click scans. No signup required.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

For a JSON operation that accepts a body, add a content-type header and the endpoint’s documented data, for example with -H "Content-Type: application/json; charset=utf-8" -d '{...}'. This is only a request pattern, not a valid payload for every route. Shell quoting differs across platforms, particularly in Windows command environments.

Authenticate securely

Basic authentication and HTTPS

Basic authentication encodes the username and password with Base64; Base64 is not encryption. Wowza says basic authentication is not considered secure unless used over HTTPS. Keep authentication enabled in production and protect credentials in transit with HTTPS where available and correctly configured. Wowza’s overview explicitly recommends not disabling authentication in production.

Rank #3
Sale
Anker USB C Hub, 7in1 Multi-Port USB Adapter, 4K@60Hz USBC to HDMI Splitter
  • Sleek 7-in-1 USB-C Hub: Features an HDMI port, two USB-A 3.0 ports, and a USB-C data port, each providing 5Gbps transfer speeds. It also includes a USB-C PD input port for charging up to 100W and dual SD and TF card slots, all in a compact design.
  • Flawless 4K@60Hz Video with HDMI: Delivers exceptional clarity and smoothness with its 4K@60Hz HDMI port, making it ideal for high-definition presentations and entertainment. (Note: Only the HDMI port supports video projection; the USB-C port is for data transfer only.)
  • Double Up on Efficiency: The two USB-A 3.0 ports and a USB-C port support a fast 5Gbps data rate, significantly boosting your transfer speeds and improving productivity.
  • Fast and Reliable 85W Charging: Offers high-capacity, speedy charging for laptops up to 85W, so you spend less time tethered to an outlet and more time being productive.
  • What You Get: Anker USB-C Hub (7-in-1), welcome guide, 18-month warranty, and our friendly customer service.

Other configured authentication modes

Wowza’s authentication guide lists basic, digest, digestfile, remotehttp, and none. The server’s chosen mode must be compatible with how passwords are stored and with the client making the request:

  • basic supports plaintext or bcrypt password encoding.
  • digest and digestfile support MD5 or SHA-256.
  • remotehttp and none are listed without a password encoding.

Version qualifications matter: Wowza documents WSE 4.8.8.01 and later as allowing digest or bcrypt hashes in admin.password, and WSE 4.8.19 and later as supporting SHA-256 encryption. Its guide recommends SHA-256 over MD5 because of potential MD5 vulnerabilities. The same guide describes a browser limitation for its SHA-256 digest configuration: in that scenario, only Firefox supports it, while Wowza Streaming Engine Manager is supported by most up-to-date browsers. Treat that as guidance for the configuration described on the guide, not a universal statement about all browsers or clients; verify current compatibility for the installed version.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Setting authentication to none is not a production shortcut. Wowza says it also disables authentication for Wowza Streaming Manager and removes the ability to manage and configure the media server using that manager.

Rank #4
Sale
UGREEN USB to USB C Adapter Combo 4-Pack, 10Gbps USB C Converter Space Gray
  • Dual Converters, Infinite Potential:Includes 2× USB C male to USB A female adapters and 2× USB A male to USB C female adapters. Perfect for a wide range of uses—tablets with Bluetooth keyboards, expand USB ports on macbook, and more. Two different converters for all your daily needs
  • Next-Level 10Gbps & 3A Charging: No more slow 480Mbps, this usb to usb c adapter has a transfer speed of up to 10Gbps, allowing you to do more transferring in less time. This usb adapter fits both USB A and USB C charger, supporting up to 3A fast charging
  • Upgraded Exquisite Craftsmanship: With an aluminum alloy housing and metal connector, the usbc to usb adapter is extremely durable and sturdy. Rigorously tested to withstand more than 10,000 times of plugging and unplugging, ensuring long-lasting performance
  • Broad Compatible: The usb c to usb adapter widely supports all USB C/ USB A devices like laptops, tablets, cellphones, car chargers, and phone chargers. Such as compatible with MacBook Pro/Air 2023/2022, Thunderbolt 4/3 Devices,Apple MagSafe Watch 9/8/7/SE/Ultra, iPad Pro 2022/2021, Samsung Galaxy S23/S20/S10, and iPhone 17/16/15 Pro. Plug and play
  • Please Note: To reach 10Gbps speed, keep the cable under 3.3 ft. For USB A Male to USB C adapters, try flipping the USB C connector. USB C Male to USB A adapters support bidirectional 10Gbps transfer within 3.3 ft

Remote HTTP authentication

For remote HTTP authentication, Wowza documents configuring a remote authentication URL, shared secret, and identity in Server.xml. The remote authentication endpoint must accept POST requests. Follow the version-specific authentication guide and protect the shared secret; do not enable this mode without implementing and securing the corresponding endpoint.

Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Support on Ko-Fi

Find and verify endpoints

Public OpenAPI reference

The public OpenAPI reference identifies the REST API as version 2.0.0 and documents route families, parameters, and supported operations. It includes application collection operations such as GET and POST, and individual application operations including GET, POST, PUT, and DELETE, as well as a PUT action route. Those examples illustrate why route-level verification matters: a collection and an individual resource may expose different operations.

The reference also documents GET /restinfo, which returns information such as API version, server name, WSE version, REST build, and license validity. Wowza states that this endpoint is available in builds 15089 or later. Confirm the build before relying on it.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Best Value
Anker USB C Hub, 5-in-1 USBC to HDMI Splitter with 4K Display
  • 5-in-1 Connectivity: Equipped with a 4K HDMI port, a 5 Gbps USB-C data port, two 5 Gbps USB-A ports, and a USB C 100W PD-IN port. Note: The USB C 100W PD-IN port supports only charging and does not support data transfer devices such as headphones or speakers.
  • Powerful Pass-Through Charging: Supports up to 85W pass-through charging so you can power up your laptop while you use the hub. Note: Pass-through charging requires a charger (not included). Note: To achieve full power for iPad, we recommend using a 45W wall charger.
  • Transfer Files in Seconds: Move files to and from your laptop at speeds of up to 5 Gbps via the USB-C and USB-A data ports. Note: The USB C 5Gbps Data port does not support video output.
  • HD Display: Connect to the HDMI port to stream or mirror content to an external monitor in resolutions of up to 4K@30Hz. Note: The USB-C ports do not support video output.
  • What You Get: Anker 332 USB-C Hub (5-in-1), welcome guide, our worry-free 18-month warranty, and friendly customer service.

Local Swagger documentation with Postman

Wowza documents a local Swagger/Postman discovery method for WSE 4.5.0 or later. The procedure uses http://localhost:8089/swagger.json after enabling the local documentation servlet and restarting the server. Port 8089 in this documentation URL is distinct from the documented REST request port 8087. The servlet must be configured and reachable; it is not the same as making an API call to a resource.

Wowza’s query examples also show end-to-end workflows, including sending adaptive-bitrate streams to Akamai using a stream-target profile. Treat these as illustrations tied to the documented resources and configuration, not as universal payloads. Confirm each route, required fields, and supported behavior in the reference for the server you operate.

Troubleshoot common request failures

  • Connection refused or timeout: Confirm the server address, configured REST port, firewall rules, and that the service is listening and reachable from the client.
  • 404 or an unexpected route response: Check the /v2/ prefix, resource path, and exact server, virtual-host, or application names. Use the reference rather than substituting guessed names.
  • 405 method not allowed: The route may not support the method used. Look up the operation for that exact collection or individual resource.
  • 401 or 403 response: Check credentials, the configured authentication mode, and whether the password encoding is supported by that mode and WSE version.
  • Unsupported or malformed content: Ensure the body is valid JSON or XML, uses the endpoint’s expected schema, and has matching Accept and Content-Type headers with UTF-8 where applicable.
  • Works in one client but not another: Compare the clients’ authentication support and the server’s configured digest or password-encoding mode. Apply the browser qualification only to the SHA-256 digest scenario described in Wowza’s guide.
  • Cannot load the local Swagger JSON: Verify that the local documentation servlet is enabled, the server was restarted after configuration, the server is WSE 4.5.0 or later, and you are using the documentation URL on port 8089 rather than the REST port.

Or let it run in the cloud

The Wowza REST API is for managing Wowza Streaming Engine. If your separate goal is to keep a prerecorded YouTube channel live around the clock, StreamNeo is a different service for that workflow: upload a recording or build a playlist, add your YouTube stream key, and go live. Nothing has to stay on at home; the uploaded quality streams as made up to 4K 60fps at one flat price per slot, automatic recovery is built in if YouTube drops the stream, and the first day is free with no card. Monthly pricing is $9.99 per month. StreamNeo is YouTube-only and plays uploaded videos rather than going live from a camera. Learn more at StreamNeo, or start the free first day.

Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Leave a Reply

Your email address will not be published. Required fields are marked *

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

More from Patch Notes

Recommended PC Tool
Recommended PC Tool
Crashes, No Sound, or Screen Glitches?Free driver scan
PC Slower Than It Used to Be?Free scan - under a minute

Two free Windows tools

One Free Minute Could Fix That PC

Before you go - each of these free tools takes about a minute and tackles what quietly slows a Windows PC down.

Special offer. View Outbyte info, uninstall instructions, EULA, and Privacy Policy.