How to access Wowza Streaming Engine Swagger Documentation with Chrome Postman

This article describes how to configure Chrome Postman to work with the Wowza Streaming Engine Swagger documentation server.

Note: Wowza Streaming Engine™ 4.5.0 or later is required.

Installation

  1. Sign in to your Google account, and then add the Postman app from the Chrome App Store to your Google Chrome web browser.
     
  2. Go to chrome://apps and click the Postman icon in the list of installed apps. The Postman app will launch in a new window.
     
  3. On your Wowza Streaming Engine server, open the [install-dir]/conf/Server.xml configuration file in a text editor, and then add the DocumentationServerBasePath setting to the Wowza Streaming Engine REST API configuration section (<Server>/<RESTInterface>). Insert this setting immediately after the DocumentationServerAuthenticationMethod setting, as shown in the following example:
    <RESTInterface>
    	<Enable>true</Enable>
    	<IPAddress>*</IPAddress>
    	<Port>8087</Port>
    	<!-- none, basic, digest-->
    	<AuthenticationMethod>digest</AuthenticationMethod>
    	<DiagnosticURLEnable>true</DiagnosticURLEnable>
    	<SSLConfig>
    		<Enable>false</Enable>
    		<KeyStorePath></KeyStorePath>
    		<KeyStorePassword></KeyStorePassword>
    		<KeyStoreType>JKS</KeyStoreType>
    		<SSLProtocol>TLS</SSLProtocol>
    		<Algorithm>SunX509</Algorithm>
    		<CipherSuites></CipherSuites>
    		<Protocols></Protocols>
    	</SSLConfig>
    	<IPWhiteList>127.0.0.1</IPWhiteList>
    	<IPBlackList></IPBlackList>
    	<EnableXMLFile>false</EnableXMLFile>
    	<DocumentationServerEnable>false</DocumentationServerEnable>
    	<DocumentationServerPort>8089</DocumentationServerPort>
    	<!-- none, basic, digest-->
    	<DocumentationServerAuthenticationMethod>digest</DocumentationServerAuthenticationMethod>
    	<DocumentationServerBasePath>/</DocumentationServerBasePath>
    	<Properties>
    	</Properties>
    </RESTInterface>
  4. Restart Wowza Streaming Engine to apply the changes.

Usage

To follow the links provided in the Wowza Streaming Engine Swagger documentation in Postman, in the Postman app, in Enter request URL, enter http://[wowza-ip-address]:8089/swagger.json. Replace [wowza-ip-address] with the IP address of your Wowza Streaming Engine media server.
Originally Published: For Wowza Streaming Engine 4.5.0 on 06-23-2016.
 

If you're having problems or want to discuss this article, post in our forum.