{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"WSE REST API Overview","description":"Developer documentation for Wowza","siteUrl":"https://developer.wowza.com","keywords":"wowza video developer portal, api reference docs","lang":"en-US","image":"https://www.wowza.com/wp-content/uploads/Graphics-Social-Profile-Images-Docs-Resources-1024x512-1.jpg","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"wse-rest-api-overview","__idx":0},"children":["WSE REST API Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Wowza Streaming Engine includes a RESTful Application Programming Interface (API) that you can use to configure, manage, and monitor a media server through HTTP requests."," ","Two common query languages for executing HTTP requests are curl and PHP."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-url","__idx":1},"children":["Base URL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resource"]}," is the HTTP endpoint that receives your request."," ","In the Wowza Streaming Engine REST API, all resources are accessed through a base URL in the following format:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["http://[your-wowza-server]:8087/v2/[path-to-resource]"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resource-path-substitutions","__idx":2},"children":["Resource path substitutions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In REST API endpoints, values shown inside ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["curly brackets {}"]}," are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["placeholders"]},"."," ","You must replace these placeholders with your actual values when making a request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For example, in the following endpoint:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}\n"},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["localhost"]},": The IP address of your Wowza Streaming Engine server. We generally use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["localhost"]}," in our curl examples."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{serverName}"]},": The name of your Wowza Streaming Engine server. The default value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_defaultServer_"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{vhostName}"]},": The name of your virtual host (VHost). The default value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_defaultVHost_"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{appName}"]},": The name of your Wowza Streaming Engine application."," ","There's no default value, but we sometimes use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["testlive"]}," in our curl examples."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The final endpoint looks something like:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"http://localhost:8087/v2/servers/_defaultServer_/vhosts/_defaultVHost_/applications/testlive\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authenticating-rest-api-requests","__idx":3},"children":["Authenticating REST API requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In our query examples, we generally assume that authentication is disabled in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Server.xml"]}," file:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"html","header":{"controls":{"copy":{}}},"source":"<AuthenticationMethod>none</AuthenticationMethod>\n","lang":"html"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By default, a fresh installation of Wowza Streaming Engine is configured with ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://www.wowza.com/docs/how-to-change-the-authentication-method-for-the-wowza-streaming-engine-rest-api#use-basic-http-authentication1"},"children":["basic authentication"]}," enabled for the REST API."," ","In production environments, we strongly recommend not disabling authentication, as this reflects best practices for security."," ","Each request should include authentication credentials using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-u"]}," option in curl."," ","Always ensure that authentication remains enabled and that credentials are protected when working with the REST API."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you set the authentication method to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["digest"]},", for example, you'll want to add that to the curl request as follows:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X [METHOD] \\\n--digest -u \"user:pass\" \\\n[Headers] \\\nhttp://[your-wowza-server]:8087/v2/[path-to-resource]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information on authenticating API requests, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://www.wowza.com/docs/how-to-change-the-authentication-method-for-the-wowza-streaming-engine-rest-api"},"children":["Change the authentication method for the Wowza Streaming Engine REST API"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"query-the-rest-api-using-curl","__idx":4},"children":["Query the REST API using curl"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Wowza Streaming Engine REST API examples on this documentation site use curl commands."," ","curl is a command-line tool that allows you to execute HTTP requests."," ","It is native to the Terminal application on macOS and Linux, but it requires some installation for use in the Command Prompt on Windows operating systems."," ","To find a download for Windows, see the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://curl.haxx.se/dlwiz/"},"children":["curl Download Wizard"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The curl syntax we use is written for Linux/Unix shells and will work as-is in that environment."," ","On Windows, the syntax differs depending on whether you use Command Prompt (CMD) or Powershell."," ","Be sure to adjust quotation marks and formatting accordingly."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The format for curl requests to the Wowza Streaming REST API is:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X [METHOD] [Headers] http://[your-wowza-server]:8087/v2/[path-to-resource]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In our query examples, we use line breaks for ease of viewing."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X [METHOD] \\\n[Headers] \\\nhttp://[your-wowza-server]:8087/v2/[path-to-resource]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Headers"]}," precede the actual HTTP request."," ","The Wowza Streaming Engine REST API requests in our examples use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["charset"]}," headers as follows:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"-H 'Accept:application/json; charset=utf-8'\n-H 'Content-Type:application/json; charset=utf-8'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}," headers instruct the requests and responses to use JSON syntax."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["charset"]}," header specifies that the requests and responses use UTF-8 character encoding."," ","The headers can also be specified discretely, as in:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"-H 'Accept: application/json'\n-H 'Content-Type: application/json'\n-H 'charset: utc-8'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you prefer to use XML syntax, change the headers to:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"-H 'Accept:application/xml; charset=utf-8'\n-H 'Content-Type:application/xml; charset=utf-8'\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["method"]}," is the action you're requesting of the resource."," ","The Wowza Streaming Engine REST API uses four curl methods, or commands:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},": Obtain information from the resource."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},": Update information or perform an action on an existing record."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},": Create a record."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]},": Remove an existing record."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Parameters"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties"]}," can be used to refine the request."," ","They generally correspond to options in the Wowza Streaming Engine Manager."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"query-the-rest-api-using-php","__idx":5},"children":["Query the REST API using PHP"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can wrap the Wowza Streaming Engine REST API with a custom PHP library to configure, manage, and monitor your server through PHP requests."," ","First, ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://github.com/WowzaMediaSystems/wse-rest-library-php"},"children":["download the PHP library from GitHub"]},"."," ","Then, point the library to your streaming media server by modifying the following lines in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["include/constants.php"]}," as follows:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"define(\"BASE_DIR\", dirname(dirname(__FILE__)));\ndefine(\"WOWZA_HOST\",\"http://localhost:8087/v2\");\ndefine(\"WOWZA_SERVER_INSTANCE\", \"serverName\");\ndefine(\"WOWZA_VHOST_INSTANCE\", \"vhostName\");\ndefine(\"WOWZA_USERNAME\", \"admin\");\ndefine(\"WOWZA_PASSWORD\", \"admin\");\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["PHP query examples are available in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["tests"]}," folder of the Wowza Streaming Engine PHP library download."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"more-resources","__idx":6},"children":["More resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://www.wowza.com/docs/how-to-change-the-authentication-method-for-the-wowza-streaming-engine-rest-api"},"children":["Change the authentication method for the Wowza Streaming Engine REST API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://www.wowza.com/docs/how-to-access-documentation-for-wowza-streaming-engine-rest-api"},"children":["Access reference documentation for the Wowza Streaming Engine REST API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://www.wowza.com/docs/wowza-streaming-engine-rest-api-query-examples-curl"},"children":["Wowza Streaming Engine REST API examples"]}]}]}]},"headings":[{"value":"WSE REST API Overview","id":"wse-rest-api-overview","depth":1},{"value":"Base URL","id":"base-url","depth":2},{"value":"Resource path substitutions","id":"resource-path-substitutions","depth":2},{"value":"Authenticating REST API requests","id":"authenticating-rest-api-requests","depth":2},{"value":"Query the REST API using curl","id":"query-the-rest-api-using-curl","depth":2},{"value":"Query the REST API using PHP","id":"query-the-rest-api-using-php","depth":2},{"value":"More resources","id":"more-resources","depth":2}],"frontmatter":{"seo":{"title":"WSE REST API Overview"}},"lastModified":"2026-06-23T17:20:07.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/wowza-engine/guides/rest-api/overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}