Skip to content
Wowza Video
/
/
/
Fetch an uptime record

Wowza Video REST API Reference Documentation (v1.11)

API lifecycle phase: Supported 2

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 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.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Terms of Use
Languages
Servers
Mock server
https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi
https://api.video.wowza.com/api/v1.11

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

Players

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

Transcoders

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

Operations

Fetch all uptime records for a transcoder

Request

This operation shows all of the uptime records for a specific transcoder. An uptime record identifies a specific transcoding session.

Path
transcoder_idstringrequired

The unique alphanumeric string that identifies the transcoder.

Query
pageinteger

Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is 1.

For more information and examples, see Get paginated query results with the Wowza Video REST API.

per_pageinteger

For use with the page parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is 1000.

curl -i -X GET \
  'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/transcoders/{transcoder_id}/uptimes?page=0&per_page=0'

Responses

Success

Bodyapplication/json
uptimesArray of objects(uptime)required
Example: [{"billed":false,"created_at":"2017-07-06T14:22:00.000Z","id":"1234abcd","running":true,"started_at":"2017-07-06T14:22:00.000Z","transcoder_id":"2adffc17","updated_at":"2017-07-06T14:22:00.000Z"},{"billed":true,"created_at":"2017-07-08T14:22:00.000Z","ended_at":"2017-07-08T16:40:00.000Z","id":"5679wxyz","running":false,"started_at":"2017-07-08T14:22:00.000Z","transcoder_id":"ff9l4838","updated_at":"2017-07-08T16:40:00.000Z"}]
uptimes[].​billedboolean

A Boolean value that indicates if the usage generated by this uptime has been sent for billing processing.

Example: ""
uptimes[].​created_atstring(date-time)

The date and time that the uptime record was created.

Example: "2017-07-06T14:22:00.000Z"
uptimes[].​ended_atstring(date-time)

The date and time that the transcoder was stopped for this uptime. If this value is not present, it indicates that the transcoder is currently running.

Example: ""
uptimes[].​idstring

The unique alphanumeric string that identifies the uptime record.

Example: "1234abcd"
uptimes[].​runningboolean

A Boolean value that indicates if the transcoder is still running for this uptime.

Example: true
uptimes[].​started_atstring(date-time)

The date and time that the transcoder started for this uptime.

Example: "2017-07-06T14:22:00.000Z"
uptimes[].​transcoder_idstring

The unique alphanumeric string that identifies the transcoder.

Example: "2adffc17"
uptimes[].​updated_atstring

The date and time that the uptime record was updated.

Example: "2017-07-06T14:22:00.000Z"
Response
application/json
{
  "uptimes": [
    { … },
    { … }
  ]
}

Fetch an uptime record

Request

This operation shows the details of a specific uptime record for a specific transcoder. An uptime record identifies a transcoding session.

Path
transcoder_idstringrequired

The unique alphanumeric string that identifies the transcoder.

idstringrequired

The unique alphanumeric string that identifies the uptime record.

curl -i -X GET \
  'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/transcoders/{transcoder_id}/uptimes/{id}'

Responses

Success

Bodyapplication/json
uptimeobject(uptime)required
Example: {"billed":false,"created_at":"2017-07-06T14:22:00.000Z","id":"1234abcd","running":true,"started_at":"2017-07-06T14:22:00.000Z","transcoder_id":"2adffc17","updated_at":"2017-07-06T14:22:00.000Z"}
uptime.​billedboolean

A Boolean value that indicates if the usage generated by this uptime has been sent for billing processing.

Example: ""
uptime.​created_atstring(date-time)

The date and time that the uptime record was created.

Example: "2017-07-06T14:22:00.000Z"
uptime.​ended_atstring(date-time)

The date and time that the transcoder was stopped for this uptime. If this value is not present, it indicates that the transcoder is currently running.

Example: ""
uptime.​idstring

The unique alphanumeric string that identifies the uptime record.

Example: "1234abcd"
uptime.​runningboolean

A Boolean value that indicates if the transcoder is still running for this uptime.

Example: true
uptime.​started_atstring(date-time)

The date and time that the transcoder started for this uptime.

Example: "2017-07-06T14:22:00.000Z"
uptime.​transcoder_idstring

The unique alphanumeric string that identifies the transcoder.

Example: "2adffc17"
uptime.​updated_atstring

The date and time that the uptime record was updated.

Example: "2017-07-06T14:22:00.000Z"
Response
application/json
{
  "uptime": {
    "billed": false,
    "created_at": "2017-07-06T14:22:00.000Z",
    "id": "1234abcd",
    "running": true,
    "started_at": "2017-07-06T14:22:00.000Z",
    "transcoder_id": "2adffc17",
    "updated_at": "2017-07-06T14:22:00.000Z"
  }
}

Create an output

Request

This operation creates an output rendition for a specific transcoder. You can create up to 10 outputs per transcoder.

Path
transcoder_idstringrequired

The unique alphanumeric string that identifies the transcoder.

Bodyapplication/jsonrequired

Provide the details of the output rendition to create in the body of the request.

outputobject(output)required
Example: {"video_codec":"h264","audio_codec":"aac","aspect_ratio_height":480,"aspect_ratio_width":848,"bitrate_audio":128,"bitrate_video":1600,"framerate_reduction":"1/2","h264_profile":"main","keyframes":"follow_source"}
output.​video_codecstringrequired

The codec used to encode the video stream. disabled sends the stream without a video track and passthrough sends the stream without transcoding the video track. Available from version 1.6.

Enum"h264""passthrough""disabled"
Example: "h264"
output.​audio_codecstringrequired

The codec used to encode the audio stream. disabled sends the stream without an audio track and passthrough sends the stream without transcoding the audio track. aac is the most commonly compatible audio codec for protocols, while opus is for WebRTC streams. Available from version 1.6.

Enum"aac""opus""passthrough""disabled"
Example: "aac"
output.​aspect_ratio_heightinteger(int32)

The height, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1080. Combined with aspect_ratio_width, makes up the input resolution.

Example: "aspect_ratio_height": 1080

Example: 480
output.​aspect_ratio_widthinteger(int32)

The width, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1920. Combined with aspect_ratio_height, makes up the input resolution.

Example: "aspect_ratio_width": 1920

Example: 848
output.​bitrate_audiointeger(int32)

The audio bitrate, in kilobits per second (Kbps). Must be between 1 and 9999. If the audio_codec is opus, the default is 510, otherwise the default is 128.

Example: "bitrate_audio": 128

Example: 128
output.​bitrate_videointeger(int32)

The video bitrate, in kilobits per second (Kbps). Must be between 1 and 10240. The default is 4000.

Example: "bitrate_audio": 1600

Example: 1600
output.​framerate_reductionstring

Reduce the frame rate of the transcoded output rendition. The default, 0, uses the encoded stream's frame rate without reduction.

Example: "frame_reduction": "1/2"

Enum"0""1/2""1/4""1/25""1/30""1/50""1/60"
Example: "1/2"
output.​h264_profilestring

The encoding method. Specify main for desktop streaming, baseline for playback on mobile devices, or high for HD playback. The default is high.

Example: "h264_profile": "main"

Enum"main""baseline""high"
Example: "main"
output.​keyframesstring

The interval used to define the compression applied to a group of frames. The default, follow_source, uses the keyframe interval of the source video.

Example: "keyframes": "follow_source"

Enum"follow_source""25""30""50""60""100""120"
Example: "follow_source"
curl -i -X POST \
  'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/transcoders/{transcoder_id}/outputs' \
  -H 'Content-Type: application/json' \
  -d '{
    "output": {
      "video_codec": "h264",
      "audio_codec": "aac",
      "aspect_ratio_height": 480,
      "aspect_ratio_width": 848,
      "bitrate_audio": 128,
      "bitrate_video": 1600,
      "framerate_reduction": "1/2",
      "h264_profile": "main",
      "keyframes": "follow_source"
    }
  }'

Responses

Success

Bodyapplication/json
outputobject(output)required
Example: {"aspect_ratio_height":480,"aspect_ratio_width":848,"bitrate_audio":128,"bitrate_video":1600,"created_at":"2020-01-29T17:16:21.964Z","framerate_reduction":"1/2","h264_profile":"main","id":"w9vJm3BJ","keyframes":"follow_source","name":"Standard Output: Video (848 x 480) + Audio","output_stream_targets":[{}],"video_codec":"h264","audio_codec":"aac","transcoder_id":"PblTJm1t","updated_at":"2020-01-31T13:47:33.964Z"}
output.​aspect_ratio_heightinteger(int32)

The height, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1080. Combined with aspect_ratio_width, makes up the input resolution.

Example: 480
output.​aspect_ratio_widthinteger(int32)

The width, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1920. Combined with aspect_ratio_height, makes up the input resolution.

Example: 848
output.​bitrate_audiointeger(int32)

The audio bitrate, in kilobits per second (Kbps). Must be between 1 and 9999. If the audio_codec is opus, the default is 510, otherwise the default is 128.

Example: 128
output.​bitrate_videointeger(int32)

The video bitrate, in kilobits per second (Kbps). Must be between 1 and 10240. The default is 4000.

Example: 1600
output.​created_atstring(date-time)

The date and time that the output rendition was created.

Example: "2020-01-29T17:16:21.964Z"
output.​framerate_reductionstring

Reduce the frame rate of the transcoded output rendition. The default, 0, uses the encoded stream's frame rate without reduction.

Enum"0""1/2""1/4""1/25""1/30""1/50""1/60"
Example: "1/2"
output.​h264_profilestring

The encoding method. Specify main for desktop streaming, baseline for playback on mobile devices, or high for HD playback. The default is high.

Enum"main""baseline""high"
Example: "main"
output.​idstring

The unique alphanumeric string that identifies the output rendition.

Example: "w9vJm3BJ"
output.​keyframesstring

The interval used to define the compression applied to a group of frames. The default, follow_source, uses the keyframe interval of the source video.

Enum"follow_source""25""30""50""60""100""120"
Example: "follow_source"
output.​namestring

A descriptive name for the output (generated, not writable).

Example: "Standard Output: Video (848 x 480) + Audio"
output.​output_stream_targetsArray of objects(output_stream_target)
Example: [{}]
output.​video_codecstring

The codec used to encode the video stream. disabled sends the stream without a video track and passthrough sends the stream without transcoding the video track. Available from version 1.6.

Enum"h264""passthrough""disabled"
Example: "h264"
output.​audio_codecstring

The codec used to encode the audio stream. disabled sends the stream without an audio track and passthrough sends the stream without transcoding the audio track. aac is the most commonly compatible audio codec for protocols, while opus is for WebRTC streams. Available from version 1.6.

Enum"aac""opus""passthrough""disabled"
Example: "aac"
output.​transcoder_idstring

The unique alphanumeric string that identifies the transcoder.

Example: "PblTJm1t"
output.​updated_atstring(date-time)

The date and time that the output rendition was updated.

Example: "2020-01-31T13:47:33.964Z"
Response
application/json
{
  "output": {
    "aspect_ratio_height": 480,
    "aspect_ratio_width": 848,
    "bitrate_audio": 128,
    "bitrate_video": 1600,
    "created_at": "2020-01-29T17:16:21.964Z",
    "framerate_reduction": "1/2",
    "h264_profile": "main",
    "id": "w9vJm3BJ",
    "keyframes": "follow_source",
    "name": "Standard Output: Video (848 x 480) + Audio",
    "output_stream_targets": [ … ],
    "video_codec": "h264",
    "audio_codec": "aac",
    "transcoder_id": "PblTJm1t",
    "updated_at": "2020-01-31T13:47:33.964Z"
  }
}

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

Assets

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

Recordings

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

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

VOD Streams

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

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

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

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

Storage

Operations related to peak storage for an account. You can use this operation to show the amount of peak recording and VOD stream storage used by your account.

Operations

VOD Streams

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

Operations

Real Time Streams

Operations related to real-time streams analytics.

Operations