Recordings

Operations related to recordings, which are created through the /live_streams or /transcoders resources. The Wowza Streaming Cloud 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 Streaming Cloud 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.

query Parameters
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 Streaming Cloud 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

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.

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.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.7/recordings"

Response samples

Content type
application/json
{
  • "recordings": [
    ]
}

Fetch a recording

This operation shows the details of a specific recording.

path Parameters
id
required
string

The unique alphanumeric string that identifies the recording.

Responses

Response Schema: application/json
required
object (recording)
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.

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.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.7/recordings/2adffc17"

Response samples

Content type
application/json
{}

Delete a recording

This operation deletes a recording.

path Parameters
id
required
string

The unique alphanumeric string that identifies the recording.

Responses

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WSC_HOST}/api/v1.7/recordings/2adffc17"

Response samples

Content type
application/json
{
  • "Example Response 1": {
    },
  • "Example Response 2": {
    },
  • "Example Response 3": {
    },
  • "Example Response 4": {
    },
  • "Example Response 5": {
    },
  • "Example Response 6": {
    },
  • "Example Response 7": {
    }
}

Fetch the state of a recording

This operation shows the current state of a recording.

path Parameters
id
required
string

The unique alphanumeric string that identifies the recording.

Responses

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

The state of the recording.

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

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.7/recordings/2adffc17/state"

Response samples

Content type
application/json
{
  • "recording": {
    }
}
➔ Next to Schedules