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.

Fetch all recordings

This operation shows limited details for all of your recordings. For detailed information, fetch a single recording.

Request
query Parameters
filter
string

Restricts the data that gets returned by filtering on one or more values associated with a field. Construct a filter using a two-part expression that specifies the field on which to filter and the logic to use to filter. Filters use a zero-based index.

For valid filter operators and filter fields, see How to get filtered query results with the Wowza Video REST API.

Example: filter[0][field]=state&filter[0][eq]=stopped

page
integer

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_page
integer

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.

Responses
200

Success

Response Schema: application/json
required
Array of objects (recordings)
Array
created_at
string <date-time>

The date and time that the recording was created.

id
string

The unique alphanumeric string that identifies the recording.

reason
string

The reason that a recording has the state failed.

file_name
string

The file name of the recording.

Note: To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names.
state
string

The state of the recording.

Enum: "uploading" "converting" "removing" "completed" "failed"
transcoder_id
string

The unique alphanumeric string that identifies the transcoder that was recorded.

updated_at
string <date-time>

The date and time that the recording was updated.

401

Unauthorized

get/recordings
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/beta/recordings"
Response samples
application/json
{
  • "recordings": [
    ]
}

Fetch a recording

This operation shows the details of a specific recording.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the recording.

Responses
200

Success

Response Schema: application/json
required
object (recording)
asset_id
string

Only applies to recordings created for Asset Management. The id for the asset associated with your recording. You can manage your asset in Asset Management.

created_at
string <date-time>

The date and time that the recording was created.

download_url
string

The URL that can be used to download the recording.

duration
integer <int64>

The length of the recording, in hours, minutes, and seconds.

file_name
string

The file name of the recording.

Note: To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names.
file_size
integer <int64>

The file size of the recording.

id
string

The unique alphanumeric string that identifies the recording.

reason
string

The reason that a recording has the state failed.

starts_at
string

The date and time that the recording started.

state
string

The state of the recording.

Enum: "uploading" "converting" "removing" "completed" "failed"
transcoder_id
string

The unique alphanumeric string that identifies the transcoder that was recorded.

transcoder_name
string

The descriptive name of the transcoder that was recorded.

transcoding_uptime_id
string <date-time>

The unique identifier associated with the transcoding uptime for this recording.

updated_at
string <date-time>

The date and time that the recording was updated.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/recordings/{id}
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/beta/recordings/2adffc17"
Response samples
application/json
{}

Delete a recording

This operation deletes a recording.

Note: You can't remove recordings that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the recording.

Responses
204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

delete/recordings/{id}
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WV_HOST}/api/beta/recordings/2adffc17"
Response samples
application/json
{
  • "Example Response 1": {
    },
  • "Example Response 2": {
    },
  • "Example Response 3": {
    },
  • "Example Response 4": {
    },
  • "Example Response 5": {
    },
  • "Example Response 6": {
    },
  • "Example Response 7": {
    },
  • "Example Response 8": {
    },
  • "Example Response 9": {
    }
}

Fetch the state of a recording

This operation shows the current state of a recording.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the recording.

Responses
200

Success

Response Schema: application/json
required
object (recording)
state
string

The state of the recording.

Enum: "uploading" "converting" "removing" "completed" "failed"
401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/recordings/{id}/state
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/beta/recordings/2adffc17/state"
Response samples
application/json
{
  • "recording": {
    }
}
Copyright © Wowza Video. All right reserved.