Wowza Streaming Cloud REST API Reference Documentation
About the REST API The Wowza Streaming Cloud TM REST API (application programming interface) offers complete programmatic control over live streams,…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
About the REST API
The Wowza Streaming Cloud TM REST API (application programming interface) offers complete programmatic control over live streams, transcoders, stream sources, and stream targets. Anything you can do in the Wowza Streaming Cloud UI can also be achieved by making HTTP-based requests to cloud-based servers through the REST API.
The Wowza Streaming Cloud 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.
In order to protect shared resources, the Wowza Streaming Cloud REST API is subject to limits. For details, see Wowza Streaming Cloud REST API limits.
About this documentation
This reference documentation is based on the open-source Swagger framework.
It allows you to view the operations, parameters, and request and reponse schemas for every resource. Request samples are presented in cURL (Shell) and JavaScript; some samples also include just the JSON object. Response samples are all JSON.
For more information and examples on using the Wowza Streaming Cloud REST API, see our library of Wowza Streaming Cloud REST API technical articles.
Query requirements
The Wowza Streaming Cloud REST API uses HTTP requests to retrieve data from cloud-based servers. Requests must contain proper JSON, two authentication keys, and the correct version number in the base path.
JSON
The Wowza Streaming Cloud 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.
Authentication
Requests to the Wowza Streaming Cloud REST API must be authenticated with two keys: an API key and an access key. Each key is a 64-character alphanumeric string that you can find on the API Access page in Wowza Streaming Cloud.
Use the wsc-api-key and wsc-access-key headers to authenticate requests, like this (in cURL):
curl -H 'wsc-api-key: [64-character-api-key-goes-here]' -H 'wsc-access-key: [64-character-access-key-goes-here]'-->
Version
The Wowza Streaming Cloud API is currently at version 1.0.0. Use v1 in your base path in every request, like this path to the live_streams endpoint:
https://api.cloud.wowza.com/api/v1/live_streamsExample query
Here is a complete example POST request, in cURL, with proper JSON syntax, headers, authentication, and version information:
curl -H 'wsc-api-key: [64-character-api-key-goes-here]' -H 'wsc-access-key: [64-character-access-key-goes-here]'
-H 'Content-Type: application/json' -X POST -d '{
"live_stream": {
"name": "My live Stream",
"...": "..."
}
}' https://api.cloud.wowza.com/api/v1/live_streamsEndpoints 104
live_streams
- GETFetch all live streams
/live_streams?page=0&per_page=0This operation shows the details of all of your live streams. - POSTCreate a live stream
/live_streamsThis operation creates a live stream. - GETFetch a live stream
/live_streams/:idThis operation shows the details of a specific live stream. - DELETEDelete a live stream
/live_streams/:idThis operation deletes a live stream, including all assigned outputs and targets. - PATCHUpdate a live stream
/live_streams/:idThis operation updates a live stream. - PUTRegenerate the connection code for a live stream
/live_streams/:id/regenerate_connection_codeThis operation regenerates the connection code of a live stream. - PUTReset a live stream
/live_streams/:id/resetThis operation resets a live stream. - PUTStart a live stream
/live_streams/:id/startThis operation starts a live stream. - GETFetch the state of a live stream
/live_streams/:id/stateThis operation shows the current state of a live stream. - GETFetch metrics for an active live stream
/live_streams/:id/statsThis operation returns a hash of metrics keys, each of which identifies a status, text description, unit, and value. - PUTStop a live stream
/live_streams/:id/stopThis operation stops a live stream. - GETFetch the thumbnail URL of a live stream
/live_streams/:id/thumbnail_urlThis operation shows the thumbnail URL of a started live stream.
players
- GETFetch all players
/players?page=0&per_page=0This operation shows the details of all of your players. - GETFetch a player
/players/:idThis operation shows details of a specific player. - PATCHUpdate a player
/players/:idThis operation updates a player. - POSTRebuild player code
/players/:id/rebuildThis operation rebuilds the player with the current configuration. - GETFetch the state of a player
/players/:id/stateThis operation shows the current state of a player. - GETFetch all player URLs
/players/:player_id/urlsThis operation shows the details of all player URLs. - POSTCreate a player URL
/players/:player_id/urlsThis operation creates a new player URL. - GETFetch a player URL
/players/:player_id/urls/:idThis operation shows the details of a player URL. - DELETEDelete a player URL
/players/:player_id/urls/:idThis operation deletes a player URL. - PATCHUpdate a player URL
/players/:player_id/urls/:idThis operation updates a player URL.
recordings
- GETFetch all recordings
/recordings?page=0&per_page=0This operation shows the details of all of your recordings. - GETFetch a recording
/recordings/:idThis operation shows the details of a specific recording. - DELETEDelete a recording
/recordings/:idThis operation deletes a recording. - GETFetch the state of a recording
/recordings/:id/stateThis operation shows the current state of a recording.
schedules
- GETFetch all schedules
/schedules?page=0&per_page=0This operation shows the details of all of your schedules. - POSTCreate a schedule
/schedulesThis operation creates a schedule. - GETFetch a schedule
/schedules/:idThis operation shows the details of a specific schedule. - DELETEDelete a schedule
/schedules/:idThis operation deletes a schedule. - PATCHUpdate a schedule
/schedules/:idThis operation updates a schedule. - PUTDisable a schedule
/schedules/:id/disableThis operation disables a schedule. - PUTEnable a schedule
/schedules/:id/enableThis operation enables a schedule. - GETFetch the state of a schedule
/schedules/:id/stateThis operation shows the current state of a schedule.
stream_sources
- GETFetch all stream sources
/stream_sources?page=0&per_page=0This operation shows the details of all of your stream sources. - POSTAdd a stream source
/stream_sourcesThis operation adds a stream source. - POSTDeprecated operation
/stream_sources/addDeprecated. POST /stream_sources/add/ is deprecated. To add a stream source, use POST /stream_sources instead. - GETFetch a stream source
/stream_sources/:idThis operation shows details of a specific stream source. - DELETEDelete a stream source
/stream_sources/:idThis operation deletes a stream source. - PATCHUpdate a stream source
/stream_sources/:idThis operation updates a stream source.
stream_targets
- GETFetch all stream targets
/stream_targets?page=0&per_page=0This operation lists the details of all of your stream targets. - POSTCreate a stream target
/stream_targetsThis operation creates a stream target. There are three types of targets that you can create: <strong>CustomStreamTarget</strong> for an an external,… - POSTDeprecated operation
/stream_targets/addDeprecated. POST /stream_targets/add/ is deprecated. To add a stream target, use POST /stream_targets instead. - GETFetch a stream target
/stream_targets/:idThis operation shows details of a specific stream target. - DELETEDelete a stream target
/stream_targets/:idThis operation deletes a stream target. - PATCHUpdate a stream target
/stream_targets/:idThis operation updates a stream target. - GETFetch current health metrics for an active Wowza ultra low latency stream target
/stream_targets/:id/metrics/currentThis operation returns a snapshot of the current connection and throughput details for an active target whose <em>type</em> is… - GETFetch historic health metrics for a Wowza ultra low latency stream target
/stream_targets/:id/metrics/historic?from=string&to=string&interval=secondThis operation shows historic connection and throughput details for target whose <em>type</em> is <strong>UltraLowLatencyStreamTarget</strong>. - PUTRegenerate the connection code for a stream target
/stream_targets/:id/regenerate_connection_codeThis operation regenerates the connection code of a stream target. - GETFetch geo-blocking for a stream target
/stream_targets/:stream_target_id/geoblockThis operation shows the details of geo-blocking applied to a specific stream target. Only stream targets whose <em>type</em> is… - POSTCreate geo-blocking for a stream target
/stream_targets/:stream_target_id/geoblockThis operation allows you to block or whitelist viewing of a stream target by geographic location. Only stream targets whose <em>type</em> is… - PATCHUpdate geo-blocking for a stream target
/stream_targets/:stream_target_id/geoblockThis operation updates the geo-blocking applied to a stream target. Only stream targets whose <em>type</em> is <strong>WowzaStreamTarget</strong> can be… - GETFetch all properties of a stream target
/stream_targets/:stream_target_id/propertiesThis operation shows the details of all of the properties assigned to a specific stream target. Properties can be applied to a… - POSTCreate a property for a stream target
/stream_targets/:stream_target_id/propertiesThis operation creates a property for a stream target. Properties can be applied to a <strong>CustomStreamTarget</strong> or… - GETFetch a property of a stream target
/stream_targets/:stream_target_id/properties/:idThis operation shows the details of a specific property assigned to a specific stream target. Properties can be applied to a… - DELETEDelete a stream target property
/stream_targets/:stream_target_id/properties/:idThis operation removes a property from a stream target. - GETFetch token authorization for a stream target
/stream_targets/:stream_target_id/token_authThis operation shows the details of the token authorization applied to a stream target. Only stream targets whose <em>type</em> is… - POSTCreate token authorization for a stream target
/stream_targets/:stream_target_id/token_authThis operation creates token authorization for a stream target. Only stream targets whose <em>type</em> is <strong>WowzaStreamTarget</strong> can use token… - PATCHUpdate token authorization for a stream target
/stream_targets/:stream_target_id/token_authThis operation updates the token authorization applied to a stream target. Only stream targets whose <em>type</em> is <strong>WowzaStreamTarget</strong> can…
transcoders
- GETFetch all transcoders
/transcoders?page=0&per_page=0This operation shows the details of all of your transcoders. - POSTCreate a transcoder
/transcodersThis operation creates a transcoder. - GETFetch a transcoder
/transcoders/:idThis operation shows the details of a specific transcoder. - DELETEDelete a transcoder
/transcoders/:idThis operation deletes a transcoder, including all of its assigned output renditions and stream targets. - PATCHUpdate a transcoder
/transcoders/:idThis operation updates a transcoder. - PUTDisable a transcoder's stream targets
/transcoders/:id/disable_all_stream_targetsThis operation disables all of the stream targets assigned to a specific transcoder. - PUTEnable a transcoder's stream targets
/transcoders/:id/enable_all_stream_targetsThis operation enables all of the stream targets assigned to a specific transcoder. - GETFetch a transcoder's recordings
/transcoders/:id/recordingsThis operation shows the details of all of the recordings for a specific transcoder. - PUTReset a transcoder
/transcoders/:id/resetThis operation resets a transcoder. - GETFetch transcoder's schedules
/transcoders/:id/schedulesThis operation shows the details of all of the schedules for a specific transcoder. - PUTStart a transcoder
/transcoders/:id/startThis operation starts a transcoder. - GETFetch the state and uptime ID of a transcoder
/transcoders/:id/stateThis operation shows the current state and uptime ID of a transcoder. - GETFetch statistics for a current transcoder
/transcoders/:id/statsThis operation responds with a hash of metrics (keys) for a currently running transcoder. Each key has a <strong>status</strong>, <strong>text</strong>… - PUTStop a transcoder
/transcoders/:id/stopThis operation stops a transcoder. - GETFetch the thumbnail URL of a transcoder
/transcoders/:id/thumbnail_urlThis operation shows the thumbnail URL of a started transcoder. - GETFetch all outputs of a transcoder
/transcoders/:transcoder_id/outputsThis operation shows the details of all of the output renditions of a specific transcoder. - POSTCreate an output
/transcoders/:transcoder_id/outputsThis operation creates an output rendition for a specific transcoder. - GETFetch an output
/transcoders/:transcoder_id/outputs/:idThis operation shows the details of a specific output rendition for a specific transcoder. - DELETEDelete an output
/transcoders/:transcoder_id/outputs/:idThis operation deletes an output, including all of its assigned targets. - PATCHUpdate an output
/transcoders/:transcoder_id/outputs/:idThis operation updates an output rendition. - POSTDeprecated operation
/transcoders/:transcoder_id/outputs/:id/add_stream_targetDeprecated. The operation POST /transcoders/{transcoder_id}/outputs/{id}/add_stream_target is deprecated. Use POST… - DELETEDeprecated operation
/transcoders/:transcoder_id/outputs/:id/remove_stream_targetDeprecated. The operation DELETE /transcoders/{transcoder_id}/outputs/{id}/remove_stream_target is deprecated. Use DELETE… - GETFetch all output stream targets of an output of a transcoder
/transcoders/:transcoder_id/outputs/:output_id/output_stream_targetsThis operation shows the details of all of the output stream targets of an output of a transcoder. - POSTCreate an output stream target
/transcoders/:transcoder_id/outputs/:output_id/output_stream_targetsThis operation creates an output stream target. Targets whose <em>type</em> is <strong>UltraLowLatencyStreamTarget</strong> can't be added to output renditions. - GETFetch an output stream target
/transcoders/:transcoder_id/outputs/:output_id/output_stream_targets/:stream_target_idThis operation shows the details of an output stream target. - DELETEDelete an output stream target
/transcoders/:transcoder_id/outputs/:output_id/output_stream_targets/:stream_target_idThis operation deletes an output stream target, including all of its assigned targets. - PATCHUpdate an output stream target
/transcoders/:transcoder_id/outputs/:output_id/output_stream_targets/:stream_target_idThis operation updates an output stream target. - PUTDisable an output stream target
/transcoders/:transcoder_id/outputs/:output_id/output_stream_targets/:stream_target_id/disableThis operation disables an output stream target. - PUTEnable an output stream target
/transcoders/:transcoder_id/outputs/:output_id/output_stream_targets/:stream_target_id/enableThis operation enables an output stream target. - PUTRestart an output stream target
/transcoders/:transcoder_id/outputs/:output_id/output_stream_targets/:stream_target_id/restartThis operation restarts an output stream target. - GETFetch a transcoder's properties
/transcoders/:transcoder_id/propertiesThis operation shows all of the properties of a specific transcoder. - POSTCreate a property for a transcoder
/transcoders/:transcoder_id/propertiesThis operation creates a property for a transcoder. For more information see the technical article How to set advanced properties by using the Wowza Streaming… - GETFetch a property for a transcoder
/transcoders/:transcoder_id/properties/:idThis operation shows the details of a specific property for a specific transcoder. - DELETEDelete a transcoder's property
/transcoders/:transcoder_id/properties/:idThis operation deletes a specific property from a specific transcoder. - GETFetch all uptime records for a transcoder
/transcoders/:transcoder_id/uptimes?page=0&per_page=0This operation shows all of the uptime records for a specific transcoder. An <em>uptime record</em> identifies a specific transcoding session. - GETFetch an uptime record
/transcoders/:transcoder_id/uptimes/:idThis operation shows the details of a specific uptime record for a specific transcoder. An <em>uptime record</em> identifies a transcoding session. - GETFetch current stream health metrics for an active transcoder
/transcoders/:transcoder_id/uptimes/:id/metrics/current?fields=stringThis operation returns a snapshot of the current source connection and processing details of an active (running) transcoder. - GETFetch historic stream health metrics for a transcoder
/transcoders/:transcoder_id/uptimes/:id/metrics/historic?fields=string&from=string&to=stringThis operation shows the historic source connection and processing details for a transcoding session (uptime record). The transcoder can be running or…
network
- GETFetch network usage for all stream sources
/usage/network/stream_sources?from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00ZThis operation shows the amount of network usage for all stream sources in the account. The default time frame is <em>from</em> the last billing date… - GETFetch network usage for all stream targets
/usage/network/stream_targets?from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00ZThis operation shows the amount of network usage for all stream targets in the account cumulatively and individually. The default time frame is <em>from</em>… - GETFetch network usage for all transcoders
/usage/network/transcoders?from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00Z&transcoder_type=transcoded&billing_mode=pay_as_you_goThis operation shows the amount of network usage (egress) for all transcoders in the account. The default time frame is <em>from</em> the last billing date…
processing time
- GETFetch stream processing time
/usage/time/transcoders?from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00Z&transcoder_type=transcoded&billing_mode=pay_as_you_goThis operation shows the amount of stream processing time used by all transcoders in the account. The default time frame is <em>from</em> the last billing…
specs
- GETFetch Swagger information
/api/v1/specsThis operation shows the details of the Swagger specification.
storage
- GETFetch peak recording storage
/usage/storage/peak_recording?from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00ZThis operation shows the amount of peak recording storage used for the account. The default time frame is <em>from</em> the last billing date <em>to</em> the…
viewer data
- GETFetch viewer data for a stream target
/usage/viewer_data/stream_targets/:id?from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00ZThis operation shows viewer data for a specific stream target. The default time frame is <em>from</em> the last billing date <em>to</em> the end of the…
API details
- Base URL
https://api-sandbox.cloud.wowza.com/api/v1- Authentication
- An API key in the wsc-access-key header
An API key in the wsc-api-key header - Operations
- 104 operations on 70 pathsGET 50POST 16PUT 15DELETE 12PATCH 11
4 marked deprecated - Main resources
- transcoders 38stream_targets 19live_streams 12players 10schedules 8stream_sources 6recordings 4network 3processing time 1specs 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
1 - Links
- Documentation · OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Wowza Streaming Cloud REST API Reference Documentation in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Wowza Streaming Cloud REST API Reference Documentation collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the wsc-access-key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Fetch all live streams” (GET /live_streams?page=0&per_page=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Wowza Streaming Cloud REST API Reference Documentation?
About the REST API The Wowza Streaming Cloud TM REST API (application programming interface) offers complete programmatic control over live streams,… It is listed under Media & content and has 104 endpoints.
Who publishes the Wowza Streaming Cloud REST API Reference Documentation?
It is listed from Wowza's public API description (an OpenAPI document), not published by Wowza on Swastik Codes. Anyone who controls wowza.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Wowza Streaming Cloud REST API Reference Documentation?
Requests go to https://api-sandbox.cloud.wowza.com/api/v1. Endpoint paths are added to this base URL.
How do I authenticate with the Wowza Streaming Cloud REST API Reference Documentation?
It accepts 2 methods: an API key in the wsc-access-key header; an API key in the wsc-api-key header.
How many endpoints does the Wowza Streaming Cloud REST API Reference Documentation have?
104 operations on 70 paths (50 GET, 16 POST, 15 PUT, 12 DELETE, 11 PATCH). The largest groups are transcoders, stream_targets, live_streams, players.
Is forking the Wowza Streaming Cloud REST API Reference Documentation free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.