{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"HTTP headers","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":"http-headers","__idx":0},"children":["HTTP headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["restUserHTTPHeaders"]}," property allows you to configure WSE REST API HTTP headers from your WSE server's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Server.xml"]}," configuration file."," ","The value for this property is a pipe-delimited list of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["header:value"]}," pairs, as shown below."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"html","header":{"controls":{"copy":{}}},"source":"<Property>\n    <Name>restUserHTTPHeaders</Name>\n    <Value>header1:value1|header2:value2A,value2B|header3:value3</Value>\n</Property>\n","lang":"html"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["restUserHTTPHeaders"]}," property and cross-origin resource sharing (CORS) ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["header:value"]}," pairs to your WSE configuration in the WSE Manager."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"add-http-headers-to-wse-manager","__idx":1},"children":["Add HTTP headers to WSE Manager"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Navigate to WSE Manager."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Server"]}," tab."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the contents lick ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Server Setup"]}," in the contents panel."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Server Setup"]}," page, click the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Properties"]}," tab."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Quick Links"]}," bar, click ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Custom"]},"."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Access to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Properties"]}," tab is limited to administrators with advanced permissions."," ","For more information, see the administrator getting started guide."]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":6},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Custom"]}," area, click ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Edit"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Add Custom Property"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Add Custom Property"]}," dialog box:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Path"]},": Select ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/Root/Server/RESTInterface"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Name"]},": Enter ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["restUserHTTPHeaders"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Type"]},": Select ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Value"]},": Enter any combination of desired CORS ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["header:value"]}," pairs in a pipe-delimited list. For details and examples, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#configure-cors-header-properties"},"children":["Configure CORS header properties"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add"]},", click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save"]},", and then restart the Wowza Streaming Engine."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"add-http-headers-to-wses-serverxml-file","__idx":2},"children":["Add HTTP headers to WSE's Server.xml file"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Navigate to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[install-dir]/conf"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Server.xml"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["restUserHTTPHeaders"]}," property to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<RESTInterface>/<Properties>"]}," element as shown below."]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"html","header":{"controls":{"copy":{}}},"source":"<RESTInterface>\n    <Properties>\n        <Property>\n            <Name>restUserHTTPHeaders</Name>\n            <Value>header1:value1|header2:value2A,value2B|header3:value3</Value>\n        </Property>\n    </Properties>\n</RESTInterface>\n","lang":"html"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For details and examples of CORS ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["header:value"]}," pairs, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#configure-cors-header-properties"},"children":["Configure CORS header properties"]},"."]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":4},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Save your changes and restart Wowza Streaming Engine."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"configure-cors-header-properties","__idx":3},"children":["Configure CORS header properties"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["CORS headers are enabled by default in the Wowza Streaming Engine 4.5.0 and later REST API."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To enable CORS for specific domains, such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["foo.example"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bar.test"]},", specify:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"html","header":{"controls":{"copy":{}}},"source":"<Properties>\n    <Property>\n        <Name>restUserHTTPHeaders</Name>\n        <Value>Access-Control-Allow-Origin:http://foo.example,http://bar.test</Value>\n    </Property>\n</Properties>\n","lang":"html"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By default, CORS only allows the GET, HEAD, and POST request methods."," ","To enable all WSE REST API request methods, add the CORS ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Access-Control-Allow-Methods"]}," header, specify:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"html","header":{"controls":{"copy":{}}},"source":"<Properties>\n    <Property>\n        <Name>restUserHTTPHeaders</Name>\n        <Value>Access-Control-Allow-Origin:http://foo.example,http://bar.test|Access-Control-Allow-Methods:OPTIONS,GET,PUT,DELETE,POST</Value>\n    </Property>\n</Properties>\n","lang":"html"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To allow the browser to access specific REST API headers, add the CORS ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Access-Control-Allow-Headers"]}," header, specify:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"html","header":{"controls":{"copy":{}}},"source":"<Properties>\n    <Property>\n        <Name>restUserHTTPHeaders</Name>\n        <Value>Access-Control-Allow-Origin:http://foo.example,http://bar.test|Access-Control-Allow-Methods:OPTIONS,GET,PUT,DELETE,POST|Access-Control-Allow-Headers:Content-Type,My-Custom-Header</Value>\n    </Property>\n</Properties>\n","lang":"html"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["restUserHTTPHeaders"]}," property value can also have a custom HTTP header."," ","For example, to add ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["My-Custom-Header"]}," to the REST API response, specify:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"html","header":{"controls":{"copy":{}}},"source":"<Properties>\n    <Property>\n        <Name>restUserHTTPHeaders</Name>\n        <Value>My-Custom-Header:[HeaderValue]</Value>\n    </Property>\n</Properties>\n","lang":"html"},"children":[]}]},"headings":[{"value":"HTTP headers","id":"http-headers","depth":1},{"value":"Add HTTP headers to WSE Manager","id":"add-http-headers-to-wse-manager","depth":2},{"value":"Add HTTP headers to WSE's Server.xml file","id":"add-http-headers-to-wses-serverxml-file","depth":2},{"value":"Configure CORS header properties","id":"configure-cors-header-properties","depth":2}],"frontmatter":{"seo":{"title":"HTTP headers"}},"lastModified":"2026-06-23T15:15:35.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/wowza-engine/guides/rest-api/headers","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}