Wowza Video REST API overview

Learn about the REST API for the Wowza Video™ service, including setting up a request, versioning, authentication, and testing out the API.

About the REST API

The Wowza Video REST API (application programming interface) uses the Hypertext Transfer Protocol (HTTP) to request data from Wowza Video servers through requests to API endpoints. You can use the Wowza Video REST API to add live streaming and playback functionality to your applications. The REST API offers complete programmatic control over live streams, transcoders, stream sources, and stream targets. Anything you can do in the Wowza Video UI can also be achieved by making HTTP-based requests to cloud-based servers through the REST API.

API requests

Requests in the Wowza Video REST API use JSON syntax for the request body and response. The examples in our articles use a curl command to execute an HTTP method in a Command Prompt or Terminal window. To learn about cURL and other methods for testing out the REST API, see Tools for testing the API.

Curl commands use the following general format:

Copy

Copied

curl -[HTTP method] --[headers] -[parameters] "[resource]"

HTTP method is the action you're requesting of the resource. Wowza Video uses these HTTP methods:

HTTP method	Description
POST	POST creates records in the resource's database. The POST method returns a response that indicates that the request was successful and includes the values of any newly created records.
GET	GET retrieves records from the resource's database. The GET method returns a response including detailed information about the queried object or objects. You may need values from a GET response in order to use them in a POST or PATCH request. Some endpoints return a cached response if you make a duplicate GET request to the endpoint within a specified period of time. See Wowza Video REST API server response caching for more information.
PATCH	PATCH updates records in the resource's database. Certain attributes can't be updated in a PATCH request and must be defined in an initial POST request. The PATCH method returns a response that indicates that the request was successful and includes the values of updated records.
PUT	PUT requests in the Wowza Video REST API start or stop a entity such as a live stream or transcoder. The PUT method response gives information about the entity that was affected.
DELETE	DELETE removes the record from the resource's database. The delete method returns a response with no content.

Headers are information that precede the actual HTTP request. Wowza Video REST API requests require headers in key:value pairs.

Key	Description	Where used
Authorization	Bearer your authentication token. Authenticates your API requests. See Authentication.	All requests.
Content-Type	application/json. Specifies that the content sent to the server is in JSON format.	For POST and PATCH HTTP methods only.

Parameters refine the request and may correspond to options in the Wowza Video user interface. They can also be known as attributes. In JSON syntax, you define a value for each parameter in key:value pairs.

Example of parameters and their assigned values in a JSON object:

Copy

Copied

{
   "transcoder": {
     "billing_mode": "pay_as_you_go",
     "broadcast_location": "us_central_iowa",
     "delivery_method": "push",
     "name": " MyPassthruTranscoder",
     "protocol": "rtmp",
     "transcoder_type": "passthrough"
   } 
}

Resource, or base URL, is the location of the server receiving the request. In the Wowza Video REST API, the base URL is

https://api.video.wowza.com/api/[version]/

Example of a full API request in curl command syntax:

Copy

Copied

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${WV_JWT}" \
-d '{
   "transcoder": {
     "billing_mode": "pay_as_you_go",
     "broadcast_location": "us_central_iowa",
     "delivery_method": "push",
     "name": " MyPassthruTranscoder",
     "protocol": "rtmp",
     "transcoder_type": "passthrough"
   } 
}' "https://api.video.wowza.com/api/v1.11/transcoders"

Info

The Wowza Video REST API publishing and playback endpoints use dynamic IP addresses. As a result, we can't provide IP addresses for allowlisting from behind a firewall.

API versions

The Wowza Video REST API is periodically versioned. Minor updates are iterated using sequential dot numbers; major versions are iterated using sequential whole numbers. To learn more about the API lifecycle and what you can expect in each stage (beta, current, etc), see Wowza Video REST API lifecycle management.

More resources

See the Wowza Video REST API deprecation policy for more information about deprecation and the deprecation schedule.
See Wowza Video REST API release notes for a detailed changelog of updates to each API version.

CORS

The Wowza Video REST API features cross-origin resource sharing, or CORS.

CORS is a W3C specification that provides headers in HTTP requests to enable a web server to safely make a network request to another domain.

API limits

Reasonable resource limits are in place to prevent excessive usage of streams and stream targets through the Wowza Video REST API. See Wowza Video REST API limits for details.

For information on limitations of the Wowza Video free trial, see Trial limitations.

Authentication

For security, all requests to the Wowza Video REST API must include authentication information in the header. Wowza Video uses JSON Web Token-based authentication, an open standard (RFC 7519) used for quickly and securely transmitting information in JSON format. You'll create an access token, or a JWT, in our Token Management portal and use it in your API requests. See Authentication for instructions on how to access your token.

Tools for testing the API

Using cURL

The Wowza Video REST API examples in 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 cURL Download Wizard.

To review curl command syntax used in our API examples, see API requests.

We use environment variables in the curl API request examples for Wowza Video to make it easier for you to copy, paste, and run commands in your Terminal or Command Prompt window. The variable syntax differs according to your operating system.

Description	macOS/Linux Variable (used in examples)	Windows Variable
JSON Web Token	${WV_JWT}	%WV_JWT%
Host	${WV_HOST}	%WV_HOST%
API version	${WV_VERSION}	%WV_VERSION%

You can set environment variables like this, depending on your operating system:

Linux or macOS:

Copy

Copied

export WV_JWT="your token here"
export WV_HOST="https://api.video.wowza.com"
export WV_VERSION="v1.10"

Windows:

Copy

Copied

set WV_JWT=your token here
set WV_HOST=https://api.video.wowza.com
set WV_VERSION=v1.10

After setting values for the environment variables, you can copy and paste API request examples into your Terminal or Command Prompt. You'll still need to substitute resource IDs and update parameter values, where appropriate.

Using a GUI-based REST API client

Other options for testing the Wowza Video REST API are applications with a graphical user interface, such as Postman, Paw, or Insomnia, that provide a user interface and responses in formatted JSON. See documentation for your chosen API testing application for detailed usage information.

Note these configuration details:

Authorization	No Auth
Headers	Authorization: Bearer your JWT. Content-Type: application/json.
Body	JSON-formatted request body that includes parameters and their assigned values

Example POST request in a GUI-based API test application:

Headers	Body

Accessing support

Sometimes you need a helping hand. You can view the Wowza Video REST API community forum to get help from other Wowza Video users and experts from around the world.

You can also contact Wowza Support for REST API issues with Wowza Video.When contacting support for an error returned via the API, be sure toinclude the following information:

The API request you sent that caused an error
The request ID returned in the error response
The request timestamp returned in the error response

The request ID and request timestamp will look something like this:

Copy

Copied

    {
        "meta": {
            "status": 401,
            "code": "ERR-401-InvalidSignature",
            "title": "Invalid Signature Error",
            "message": "Invalid signature.",
            "description": ""
        },
        "request_id": "12a6c19ad7fa49dc9126e6ce6c7ca9d7",
        "request_timestamp": "2019-11-04T15:38:47.198Z"
    }