Wowza Video REST API Reference Documentation (v1.8)

Download OpenAPI specification:Download

License: Terms of Use

API lifecycle phase: Current

About the REST API


The Wowza VideoTM REST API allows you to add live streaming and playback functionality to your applications. It 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.

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.

Limits

In order to protect shared resources, the Wowza Video REST API is subject to limits. For details, see Wowza Video REST API limits.

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. For details, see Wowza Video REST API lifecycle management.

Each version is one of these types:

  • Beta: The beta version contains everything that's in the current version as well as some features and functionality that are still in development. These work-in-progress features aren't fully tested and are subject to change. When we're done testing, we'll promote the beta version to the current version and then create a new beta with new features. You're free to use the beta version for testing and evaluation, but beta versions aren't intended for use in production environments and we caution against using a beta in production. There is only one beta version available at any time.
  • Current: The current version offers the most complete, up-to-date, tested, and stable code base. We strongly recommend using the current version in your production environment. There is only one current version available at any time.
  • Supported 1: The first supported version was current at one time but has been replaced by a newer version of the API. This version doesn't have the newest features, and may contain features or functions that are outdated and don't offer the most efficient methods for accomplishing your streaming goals. If you're using this version, we recommend that you upgrade to the current version, as soon as possible.
  • Supported 2: The second supported version is no longer part of our active code base and the functionality is frozen. This version is offered as a convenience as you plan and execute your migration to the current version.
  • Deprecated: A deprecated version isn't guaranteed to work in production environments. While the paths to the endpoints remain operable, the calls are re-routed to the Supported 2 endpoints. Because of this, if there are compatibility differences between Deprecated and Supported 2, you'll receive error responses on those requests. Also, all relevant documentation is no longer accessible. If you're using a deprecated version, update to the current version immediately.
  • Discontinued: A discontinued version is no longer accessible. This stage was formerly known as Sunset.

Query for version status

You can use the following GET request to fetch the current status for versions of the REST API.


curl -X GET \

-H 'Authorization: Bearer ${WV_JWT}' \

'https://api.video.wowza.com/api/versions'

The response should look something like this, but it will differ according to current version status. Note that the beta version is not included in the response.


{
  "1.8": {
    "status": "current",
    "base_uri": "/api/v1.8"
     },
    "1.7": {
        "status": "supported",
        "base_uri": "/api/v1.7"
    }
    ...
}

Documentation


Reference doc

This reference documentation provides details about the operations, parameters, and request and reponse schemas for every resource and endpoint in the Wowza Video REST API.

Samples appear in the right column. Sample requests are presented in cURL (Shell) and JavaScript; some samples also include just the JSON object. Response samples are all JSON. Examples in cURL use environment variables so you can easily copy and paste them. To learn more, see Using cURL.

Reference documentation is available for every version of the API. Use the Version menu at the top of the page to access the reference doc for a different version of the API.

Release notes

Release notes are also available for each version. Release notes detail additions, changes, and deletions for each version. To learn more, see Wowza Video REST API release notes.

Technical articles

For additional documentation, including more detailed examples on using the Wowza Video REST API, see our library of Wowza Video REST API technical articles.

Query requirements


The Wowza Video REST API uses HTTP requests to retrieve data from cloud-based servers. Requests must contain proper JSON, an authentication key, and the correct version number as the base path.

Use JSON

The Wowza Video REST API uses the JSON API specification to request and return data. This means requests must include the header Content-Type: application/json and must include a single resource object in JSON format as primary data.

Responses include HTTP status codes that indicate whether the query was successful. If there was an error, a description explains the problem so that you can fix it and try again.

Authenticate

Wowza Video is transitioning to the JSON Web Token-based > authentication scheme. > JWT-based authentication is available starting in the 1.8 of > the API alongside the older API key/acess key and HMAC authentication schemes. > However, version 1.9 and future versions of the API will only support JWT, and > we encourage you to update your integrations to use JWT as soon as possible. > > All help content shows code samples with JWT-based authentication. > > To use JWT-based authentication, you’ll need to create a personal > access token in the Token Management portal and use it in your API > requests. To learn more, see the Authentication.

Requests to the Wowza Video REST API must include headers for authentication. Send the JWT as a bearer token in an Authorization header of your API requests, like this (in cURL):

curl -H 'Authorization: Bearer [your JWT]' \

See Authentication for more detailed information about authenticating API requests.

Specify a version

You must specify the version of the Wowza Video REST API you're using for the base path of your request. Use the version number or beta, as in


https://api.video.wowza.com/api/v1.8/live_streams

or


https://api.video.wowza.com/api/beta/live_streams

Example query

Here is a complete example POST request, in cURL, with proper JSON syntax, headers, authentication, and version information:

curl -X POST \
-H 'Authorization: Bearer [your JWT]' \
-H 'Content-Type: application/json' \
-d '{
    "live_stream": {
      "name": "My live Stream",
      "...": "..."
    }
  }' 'https://api.video.wowza.com/api/[version]/live_streams'
Copyright © Wowza Video. All right reserved.