Skip to content
Wowza Video
/
/
/
Update a schedule

Wowza Video REST API Reference Documentation (v2.0)

API lifecycle phase: Current

Want to take the API for a test run?

All you'll need is a Wowza Video subscription, or free trial, for the API access token. Then, fork our collection in Postman and you'll be making calls to our REST API in minutes!

See Trial the Wowza Video REST API using Postman for more information.

This reference documentation provides details about the operations, parameters, and request and response 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.

Note: If you haven't moved over to the new Wowza Video UI experience, you won't be able to access v2.0 of the API. We're migrating customers iteratively. See Upgrade to the Wowza Video 2.0 REST API for more information.
Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Terms of Use
Languages
Servers
Mock server
https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi
https://api.video.wowza.com/api/v2.0

Live Streams

Operations related to live streams. A live stream is a single, linear video broadcast. You broadcast a live stream by receiving encoded source video into the Wowza Video service and letting Wowza Video transcode the stream and deliver it to viewers. A live stream is essentially a one-stop method for creating a transcoder, output renditions, stream targets, and associated players.

Operations

Transcoders

Operations related to transcoders, output renditions, and output stream targets.

Operations

Stream Sources

Operations related to stream sources. You can create a Wowza stream source and associate it to a live stream or transcoder.

Operations

Stream Targets

Operations related to stream targets. A stream target is a destination for a stream. Stream targets can be Wowza Video edge resources; custom, external destinations, target destinations.

Operations

Schedules

Operations related to schedules. Schedules allow you to automatically start or stop a live stream or transcoder at a predetermined date and time. You can configure a schedule to start and/or stop a live stream or transcoder just once, or you can configure it to repeat the behavior on a regular basis. See About schedules to learn more.

Operations

Fetch a schedule

Request

This operation shows the details of a specific schedule.

Path
idstringrequired

The unique alphanumeric string that identifies the schedule.

curl -i -X GET \
  'https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/schedules/{id}'

Responses

Success

Bodyapplication/json
scheduleobject(schedule)required
Example: {"id":"28bwb5WT","state":"disabled","name":"Scheduled recurring start for my camera","time_zone":"America/New_York","transcoder_id":"VGB21JFJ","transcoder_name":"My Camera","recurrence_type":"recur","recurrence_data":"monday,tuesday,wednesday,thursday,friday","action_type":"start_stop","start_transcoder":"2020-02-01T00:00:00.000Z","stop_transcoder":"2020-02-29T23:59:59.999Z","start_repeat":"2020-02-01T00:00:00.000Z","end_repeat":"2020-02-29T00:00:00.000Z","created_at":"2020-01-29T17:16:21.995Z","updated_at":"2020-01-31T07:00:48.995Z"}
schedule.​action_typestring

The type of action that the schedule should trigger on the transcoder. The default is start.

Enum"start""stop""start_stop"
Example: "start_stop"
schedule.​created_atstring(date-time)

The date and time that the schedule was created.

Example: "2020-01-29T17:16:21.995Z"
schedule.​end_repeatstring(date)

The month, day, and year that a recurring schedule should stop running. Specify YYYY-MM-DD.

Example: "2020-02-29T00:00:00.000Z"
schedule.​idstring

The unique alphanumeric string that identifies the schedule.

Example: "28bwb5WT"
schedule.​namestring

A descriptive name for the schedule. Maximum 255 characters.

Example: "Scheduled recurring start for my camera"
schedule.​recurrence_datastring

The day or days of the week that a recurring schedule should run.

Enum"sunday""monday""tuesday""wednesday""thursday""friday""saturday"
Example: "monday,tuesday,wednesday,thursday,friday"
schedule.​recurrence_typestring

A schedule can run one time only (once) or repeat (recur) until a specified end_repeat date. The default is once.

Enum"once""recur"
Example: "recur"
schedule.​start_repeatstring(date)

The month, day, and year that the recurring schedule should go into effect. Specify YYYY-MM-DD.

Example: "2020-02-01T00:00:00.000Z"
schedule.​start_transcoderstring(date-time)

The month, day, year, and time of day that the action_type start should occur. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC.

Example: "2020-02-01T00:00:00.000Z"
schedule.​statestring

A schedule must be enabled to run. Specify enabled to run the schedule or disabled to turn off the schedule so that it doesn't run.

Enum"enabled""disabled""expired"
Example: "disabled"
schedule.​stop_transcoderstring(date-time)

The month, day, year, and time of day that the action_type stop should occur. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC.

Example: "2020-02-29T23:59:59.999Z"
schedule.​time_zonestring

The time zone the schedule runs in.

Example: "America/New_York"
schedule.​transcoder_idstring

The unique alphanumeric string that identifies the transcoder being scheduled.

Example: "VGB21JFJ"
schedule.​transcoder_namestring

The name of the transcoder being scheduled.

Example: "My Camera"
schedule.​updated_atstring(date-time)

The date and time that the schedule was updated.

Example: "2020-01-31T07:00:48.995Z"
Response
application/json
{
  "schedule": {
    "id": "28bwb5WT",
    "state": "disabled",
    "name": "Scheduled recurring start for my camera",
    "time_zone": "America/New_York",
    "transcoder_id": "VGB21JFJ",
    "transcoder_name": "My Camera",
    "recurrence_type": "recur",
    "recurrence_data": "monday,tuesday,wednesday,thursday,friday",
    "action_type": "start_stop",
    "start_transcoder": "2020-02-01T00:00:00.000Z",
    "stop_transcoder": "2020-02-29T23:59:59.999Z",
    "start_repeat": "2020-02-01T00:00:00.000Z",
    "end_repeat": "2020-02-29T00:00:00.000Z",
    "created_at": "2020-01-29T17:16:21.995Z",
    "updated_at": "2020-01-31T07:00:48.995Z"
  }
}

Update a schedule

Request

This operation updates a schedule.

Path
idstringrequired

The unique alphanumeric string that identifies the schedule.

Bodyapplication/jsonrequired

Provide the details of the schedule to update in the body of the request.

scheduleobject(schedule)required
schedule.​action_typestring

The type of action that the schedule should trigger on the transcoder. The default is start.

Example: "action_type": "stop"

Enum"start""stop""start_stop"
Example: "start_stop"
schedule.​namestring

A descriptive name for the schedule. Maximum 255 characters.

Example: "name": "My Updated Schedule"

Example: "Scheduled start for my camera"
schedule.​end_repeatstring(date)

The month, day, and year that a recurring schedule should stop running. Specify YYYY-MM-DD.

Example: "end_repeat": "2020-02-29T00:00:00.000Z"

Example: "2020-02-29T00:00:00.000Z"
schedule.​recurrence_datastring

The day or days of the week that a recurring schedule should run.

Example: "recurrence_data": "monday,tuesday,wednesday,thursday,friday"

Enum"sunday""monday""tuesday""wednesday""thursday""friday""saturday"
Example: "monday,tuesday,wednesday,thursday,friday"
schedule.​start_repeatstring(date)

The month, day, and year that the recurring schedule should go into effect. Specify YYYY-MM-DD.

Example: "start_repeat": "2020-02-01T00:00:00.000Z"

Example: "2020-02-01T00:00:00.000Z"
schedule.​start_transcoderstring(date-time)

The month, day, year, and time of day that the action_type start should occur. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC.

Example: "start_transcoder": "2020-02-01T00:00:00.000Z"

Example: "2020-02-01T00:00:00.000Z"
schedule.​stop_transcoderstring(date-time)

The month, day, year, and time of day that the action_type stop should occur. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC.

Example: "start_transcoder": "2020-02-29T23:59:59.999Z"

Example: "2020-02-29T23:59:59.999Z"
schedule.​time_zonestring

The time zone the schedule runs in.

Click to expand for the full list of valid values
LocationsWowza Video time_zone value
International Date Line WestEtc/GMT+12
Midway IslandPacific/Midway
American SamoaPacific/Pago_Pago
HawaiiPacific/Honolulu
AlaskaAmerica/Juneau
Pacific Time (US & Canada)America/Los_Angeles
TijuanaAmerica/Tijuana
Mountain Time (US & Canada)America/Denver
ArizonaAmerica/Phoenix
ChihuahuaAmerica/Chihuahua
MazatlanAmerica/Mazatlan
Central Time (US & Canada)America/Chicago
SaskatchewanAmerica/Regina
GuadalajaraAmerica/Mexico_City
Mexico CityAmerica/Mexico_City
MonterreyAmerica/Monterrey
Central AmericaAmerica/Guatemala
Eastern Time (US & Canada)America/New_York
Indiana (East)America/Indiana/Indianapolis
BogotaAmerica/Bogota
LimaAmerica/Lima
QuitoAmerica/Lima
Atlantic Time (Canada)America/Halifax
CaracasAmerica/Caracas
La PazAmerica/La_Paz
SantiagoAmerica/Santiago
NewfoundlandAmerica/St_Johns
BrasiliaAmerica/Sao_Paulo
Buenos AiresAmerica/Argentina/Buenos_Aires
MontevideoAmerica/Montevideo
GeorgetownAmerica/Guyana
Puerto RicoAmerica/Puerto_Rico
GreenlandAmerica/Godthab
Mid-AtlanticAtlantic/South_Georgia
AzoresAtlantic/Azores
Cape Verde Is.Atlantic/Cape_Verde
DublinEurope/Dublin
EdinburghEurope/London
LisbonEurope/Lisbon
LondonEurope/London
CasablancaAfrica/Casablanca
MonroviaAfrica/Monrovia
UTCEtc/UTC
BelgradeEurope/Belgrade
BratislavaEurope/Bratislava
BudapestEurope/Budapest
LjubljanaEurope/Ljubljana
PragueEurope/Prague
SarajevoEurope/Sarajevo
SkopjeEurope/Skopje
WarsawEurope/Warsaw
ZagrebEurope/Zagreb
BrusselsEurope/Brussels
CopenhagenEurope/Copenhagen
MadridEurope/Madrid
ParisEurope/Paris
AmsterdamEurope/Amsterdam
BerlinEurope/Berlin
BernEurope/Zurich
ZurichEurope/Zurich
RomeEurope/Rome
StockholmEurope/Stockholm
ViennaEurope/Vienna
West Central AfricaAfrica/Algiers
BucharestEurope/Bucharest
CairoAfrica/Cairo
HelsinkiEurope/Helsinki
KyivEurope/Kiev
RigaEurope/Riga
SofiaEurope/Sofia
TallinnEurope/Tallinn
VilniusEurope/Vilnius
AthensEurope/Athens
IstanbulEurope/Istanbul
MinskEurope/Minsk
JerusalemAsia/Jerusalem
HarareAfrica/Harare
PretoriaAfrica/Johannesburg
KaliningradEurope/Kaliningrad
MoscowEurope/Moscow
St. PetersburgEurope/Moscow
VolgogradEurope/Volgograd
SamaraEurope/Samara
KuwaitAsia/Kuwait
RiyadhAsia/Riyadh
NairobiAfrica/Nairobi
BaghdadAsia/Baghdad
TehranAsia/Tehran
Abu DhabiAsia/Muscat
MuscatAsia/Muscat
BakuAsia/Baku
TbilisiAsia/Tbilisi
YerevanAsia/Yerevan
KabulAsia/Kabul
EkaterinburgAsia/Yekaterinburg
IslamabadAsia/Karachi
KarachiAsia/Karachi
TashkentAsia/Tashkent
ChennaiAsia/Kolkata
KolkataAsia/Kolkata
MumbaiAsia/Kolkata
New DelhiAsia/Kolkata
KathmanduAsia/Kathmandu
AstanaAsia/Dhaka
DhakaAsia/Dhaka
Sri JayawardenepuraAsia/Colombo
AlmatyAsia/Almaty
NovosibirskAsia/Novosibirsk
RangoonAsia/Rangoon
BangkokAsia/Bangkok
HanoiAsia/Bangkok
JakartaAsia/Jakarta
KrasnoyarskAsia/Krasnoyarsk
BeijingAsia/Shanghai
ChongqingAsia/Chongqing
Hong KongAsia/Hong_Kong
UrumqiAsia/Urumqi
Kuala LumpurAsia/Kuala_Lumpur
SingaporeAsia/Singapore
TaipeiAsia/Taipei
PerthAustralia/Perth
IrkutskAsia/Irkutsk
UlaanbaatarAsia/Ulaanbaatar
SeoulAsia/Seoul
OsakaAsia/Tokyo
SapporoAsia/Tokyo
TokyoAsia/Tokyo
YakutskAsia/Yakutsk
DarwinAustralia/Darwin
AdelaideAustralia/Adelaide
CanberraAustralia/Melbourne
MelbourneAustralia/Melbourne
SydneyAustralia/Sydney
BrisbaneAustralia/Brisbane
HobartAustralia/Hobart
VladivostokAsia/Vladivostok
GuamPacific/Guam
Port MoresbyPacific/Port_Moresby
MagadanAsia/Magadan
SrednekolymskAsia/Srednekolymsk
Solomon Is.Pacific/Guadalcanal
New CaledoniaPacific/Noumea
FijiPacific/Fiji
KamchatkaAsia/Kamchatka
Marshall Is.Pacific/Majuro
AucklandPacific/Auckland
WellingtonPacific/Auckland
Nuku'alofaPacific/Tongatapu
Tokelau Is.Pacific/Fakaofo
Chatham Is.Pacific/Chatham
SamoaPacific/Apia

Default: Etc/UTC

Example: America/New_York

Example: "America/New_York"
curl -i -X PATCH \
  'https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/schedules/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "schedule": {
      "action_type": "start_stop",
      "name": "Scheduled start for my camera",
      "end_repeat": "2020-02-29T00:00:00.000Z",
      "recurrence_data": "monday,tuesday,wednesday,thursday,friday",
      "start_repeat": "2020-02-01T00:00:00.000Z",
      "start_transcoder": "2020-02-01T00:00:00.000Z",
      "stop_transcoder": "2020-02-29T23:59:59.999Z",
      "time_zone": "America/New_York"
    }
  }'

Responses

Success

Bodyapplication/json
scheduleobject(schedule)required
Example: {"id":"28bwb5WT","state":"disabled","name":"Scheduled recurring start for my camera","time_zone":"America/New_York","transcoder_id":"VGB21JFJ","transcoder_name":"My Camera","recurrence_type":"recur","recurrence_data":"monday,tuesday,wednesday,thursday,friday","action_type":"start_stop","start_transcoder":"2020-02-01T00:00:00.000Z","stop_transcoder":"2020-02-29T23:59:59.999Z","start_repeat":"2020-02-01T00:00:00.000Z","end_repeat":"2020-02-29T00:00:00.000Z","created_at":"2020-01-29T17:16:21.995Z","updated_at":"2020-01-31T07:00:48.995Z"}
schedule.​action_typestring

The type of action that the schedule should trigger on the transcoder. The default is start.

Enum"start""stop""start_stop"
Example: "start_stop"
schedule.​created_atstring(date-time)

The date and time that the schedule was created.

Example: "2020-01-29T17:16:21.995Z"
schedule.​end_repeatstring(date)

The month, day, and year that a recurring schedule should stop running. Specify YYYY-MM-DD.

Example: "2020-02-29T00:00:00.000Z"
schedule.​idstring

The unique alphanumeric string that identifies the schedule.

Example: "28bwb5WT"
schedule.​namestring

A descriptive name for the schedule. Maximum 255 characters.

Example: "Scheduled recurring start for my camera"
schedule.​recurrence_datastring

The day or days of the week that a recurring schedule should run.

Enum"sunday""monday""tuesday""wednesday""thursday""friday""saturday"
Example: "monday,tuesday,wednesday,thursday,friday"
schedule.​recurrence_typestring

A schedule can run one time only (once) or repeat (recur) until a specified end_repeat date. The default is once.

Enum"once""recur"
Example: "recur"
schedule.​start_repeatstring(date)

The month, day, and year that the recurring schedule should go into effect. Specify YYYY-MM-DD.

Example: "2020-02-01T00:00:00.000Z"
schedule.​start_transcoderstring(date-time)

The month, day, year, and time of day that the action_type start should occur. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC.

Example: "2020-02-01T00:00:00.000Z"
schedule.​statestring

A schedule must be enabled to run. Specify enabled to run the schedule or disabled to turn off the schedule so that it doesn't run.

Enum"enabled""disabled""expired"
Example: "disabled"
schedule.​stop_transcoderstring(date-time)

The month, day, year, and time of day that the action_type stop should occur. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC.

Example: "2020-02-29T23:59:59.999Z"
schedule.​time_zonestring

The time zone the schedule runs in.

Example: "America/New_York"
schedule.​transcoder_idstring

The unique alphanumeric string that identifies the transcoder being scheduled.

Example: "VGB21JFJ"
schedule.​transcoder_namestring

The name of the transcoder being scheduled.

Example: "My Camera"
schedule.​updated_atstring(date-time)

The date and time that the schedule was updated.

Example: "2020-01-31T07:00:48.995Z"
Response
application/json
{
  "schedule": {
    "id": "28bwb5WT",
    "state": "disabled",
    "name": "Scheduled recurring start for my camera",
    "time_zone": "America/New_York",
    "transcoder_id": "VGB21JFJ",
    "transcoder_name": "My Camera",
    "recurrence_type": "recur",
    "recurrence_data": "monday,tuesday,wednesday,thursday,friday",
    "action_type": "start_stop",
    "start_transcoder": "2020-02-01T00:00:00.000Z",
    "stop_transcoder": "2020-02-29T23:59:59.999Z",
    "start_repeat": "2020-02-01T00:00:00.000Z",
    "end_repeat": "2020-02-29T00:00:00.000Z",
    "created_at": "2020-01-29T17:16:21.995Z",
    "updated_at": "2020-01-31T07:00:48.995Z"
  }
}

Delete a schedule

Request

This operation deletes a schedule.

Path
idstringrequired

The unique alphanumeric string that identifies the schedule.

curl -i -X DELETE \
  'https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/schedules/{id}'

Responses

No Content

Response
No content

Real-Time Streams

Operations related to Real-Time Streaming at Scale. If your audience is fewer than 300 viewers or you want to deliver a stream in near real time alongside other delivery protocols, use our WebRTC solution.

To enable and purchase capacity for Real-Time Streaming at Scale for your account and access the /real_time operations, contact 720.279.8163 or schedule a call.
Operations

Videos

Operations related to uploading and categorizing videos.

Operations

Categories

Operations related to categorizing videos.

Operations

Advanced Token Authentication

Operations related to using advanced token authentication, known in Wowza Video as a default playback token behavior option, with videos.

Use token authentication when distributing valuable or sensitive video content to audiences to ensure that only authorized users can access the content within the intended application. This allows for protection of intellectual property, compliance with regulations, and the ability to maintain control over content distribution. The token is embedded in the videos' embed URLs.

Through the UI or Wowza Video API, you can choose one of the following options for token authentication of a video:

  • NO_TOKEN - Video files are accessible and can be downloaded and played by anyone at any time. This is the default.

  • BASIC_TOKEN - The platform automatically creates tokenized video URLs. This setting makes it hard for a viewer to extract the video URL and store it for usage in unintended applications over time since the embed URL, which has the token as part of the URL, will only be playable for 48 hours. The token auto renews after 48 hours when used in the intended application.

  • ADVANCED_TOKEN - You add the stream's JS embed code (Share Stream) and a token to your site to provide tokenization. The protections are similar to those for the Basic Token option except you customize the time limit, geographical limits, etc. during token creation.

  • FOLLOW_DEFAULT: - The token behavior is based on the Default Playback Token Behavior setting you selected for your Wowza account. See the Org Settings page in Wowza Video article for where to set this configuration.

    Note: You'll use the /videos endpoints to update and review the token authentication enums bulleted above.

Before selecting to use the ADVANCED_TOKEN, you must, first, either:

  • Generate a key id via the Wowza Video API, then customize and generate a token via the Wowza Video 2.0 API to add to your site. You'll need the key id to create and sign the token.
  • Generate a key id and key via the Wowza Video 2.0 API, then customize and generate a standard common access token (CAT) through the means you usually use to create tokens to add to your site. You'll need the key id and key to create and sign the token.

After you have your playback token, you add the video JS-embed and the playback token to your site if you're going to use the ADVANCED_TOKEN option. The JS-embed code automatically adds the player and related video to your site. See the section on <a href="how to embed the player and video".

Operations

Clipping

Operations related to clipping and stitching videos and live streams.

Operations

Viewers

Operations related to viewer analytics.

Operations

Ingest

Operations related to ingest analytics for a live stream.

Operations

Engagement

Operations related to engagement analytics for a VOD stream.

Operations

Popularity

Operations related to popularity analytics.

Operations

Quality of Experience

Operations related to quality of experience metrics.

Operations

Account

Operations related to stream analytics for an account.

Operations

Transcoders

Operations related to transcoder analytics.

Operations

Stream Targets

Operations related to stream target analytics, including CDN usage and viewer data.

Operations

Real Time Streams

Operations related to real-time streams analytics.

Operations

Assets

The assets operations are deprecated in 2.0. Use the /videos endpoints instead.

Operations related to assets, which are created through the /assets resources. The Wowza Video service can store and transcode mp4 files that you can tag, manage, and restream.

Operations

Players

The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.

Operations related to players, which are created through the /live_streams resource. Players created through Wowza Video live streams can be embedded into your own web page or played through a web page hosted by Wowza Video.

Operations

Recordings

The recordings operations are deprecated in 2.0. Use the /videos endpoints instead.

Operations related to recordings, which are created through the /live_streams or /transcoders resources. The Wowza Video service can create MP4 recordings of your live streams and transcoded output. Recordings can be downloaded and saved locally. They're based on the highest-bitrate output rendition that Wowza Video generates from your video source. See About recordings to learn more.

Operations

VOD Streams

The VOD stream operations are deprecated in 2.0. Use the /videos endpoints instead.

Operations related to video on demand (VOD) streams, which are created through the /live_streams or /transcoders resources. A VOD stream is a recording of a live stream that viewers can replay at a later date. After the broadcast is over and the live stream or transcoder is stopped, Wowza Video creates the VOD stream and generates a playback URL. See About VOD Streams to learn more.

Operations

Storage

The storage operations are deprecated in 2.0.

Operations related to peak and current storage for an account.

Operations

VOD Streams (Usage)

The VOD stream operations are deprecated in 2.0.

Operations related to video on demand (VOD) stream analytics.

Operations