Stream Sources

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

Wowza Stream Sources

When you set up a Wowza stream source with a live stream or transcoder, Wowza Video can automatically detect broadcast location, automatically start a stream when the video source starts, and automatically stop a stream after the video source disconnects.

Fetch all stream sources

This operation shows limited details for all of your stream sources. For detailed information, fetch a single stream source of the appropriate type.

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 (stream_sources)
Array
created_at
string <date-time>

The date and time that the stream source was created.

id
string

The unique alphanumeric string that identifies the stream source.

name
string

A descriptive name for the stream source. Maximum 255 characters.

type
string

An akamai stream source is a Wowza Video edge resource that sends streams to a Wowza Video transcoder using the RTMP protocol. A wowza stream source enables automatic transcoder start, stop, and broadcast location detection.

Enum: "akamai" "wowza"
updated_at
string <date-time>

The date and time that the stream source was updated.

401

Unauthorized

get/stream_sources
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.9/stream_sources"
Response samples
application/json
{
  • "stream_sources": [
    ]
}

Create a Wowza stream source

(Available from version 1.4) This operation creates a Wowza stream source. A Wowza stream source enables automatic transcoder start, stop, and broadcast location detection.

Request
Request Body schema: application/json

Provide the details of the stream source to add in the body of the request.

required
object (stream_source_wowza)
name
required
string

A descriptive name for the Wowza stream source. Maximum 255 characters.

Responses
201

Success

Response Schema: application/json
required
object (stream_source_wowza)
created_at
string <date-time>

The date and time that the Wowza stream source was created.

id
string

The unique alphanumeric string that identifies the Wowza stream source.

name
string

A descriptive name for the Wowza stream source. Maximum 255 characters.

primary_url
string

The origin URL where you send your source stream.

state
string

The current state of the Wowza stream source.

Enum: "started" "stopped" "error"
stream_name
string

The name of the stream that you can use to configure the source encoder to connect to the Wowza stream source.

updated_at
string <date-time>

The date and time that the Wowza stream source was updated.

401

Unauthorized

422

Unprocessable Entity

post/stream_sources/wowza
Request samples
application/json
{
  • "stream_source_wowza": {
    }
}
Response samples
application/json
{
  • "stream_source_wowza": {
    }
}

Fetch all Wowza stream sources

(Available from version 1.4) This operation shows limited details for all of your Wowza stream sources. A Wowza stream source enables automatic transcoder start, stop, and broadcast location detection. For detailed information, fetch a single Wowza stream source.

Request
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 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 (stream_sources_wowza)
Array
created_at
string <date-time>

The date and time that the Wowza stream source was created.

id
string

The unique alphanumeric string that identifies the Wowza stream source.

name
string

A descriptive name for the Wowza stream source. Maximum 255 characters.

updated_at
string <date-time>

The date and time that the Wowza stream source was updated.

401

Unauthorized

get/stream_sources/wowza
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.9/stream_sources/wowza"
Response samples
application/json
{
  • "stream_sources_wowza": [
    ]
}

Fetch a Wowza stream source

(Available from version 1.4) This operation shows details of a specific Wowza stream source. A Wowza stream source enables automatic transcoder start, stop, and broadcast location detection.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the Wowza stream source.

Responses
200

Success

Response Schema: application/json
required
object (stream_source_wowza)
created_at
string <date-time>

The date and time that the Wowza stream source was created.

id
string

The unique alphanumeric string that identifies the Wowza stream source.

name
string

A descriptive name for the Wowza stream source. Maximum 255 characters.

primary_url
string

The origin URL where you send your source stream.

state
string

The current state of the Wowza stream source.

Enum: "started" "stopped" "error"
stream_name
string

The name of the stream that you can use to configure the source encoder to connect to the Wowza stream source.

updated_at
string <date-time>

The date and time that the Wowza stream source was updated.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/stream_sources/wowza/{id}
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.9/stream_sources/wowza/2adffc17"
Response samples
application/json
{
  • "stream_source_wowza": {
    }
}

Update a Wowza stream source

(Available from version 1.4) This operation updates a Wowza stream source. A Wowza stream source enables automatic transcoder start, stop, and broadcast location detection.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the Wowza stream source.

Request Body schema: application/json

Provide the details of the stream source to update in the body of the request.

required
object (stream_source_wowza)
name
required
string

A descriptive name for the Wowza stream source. Maximum 255 characters.

Responses
200

Success

Response Schema: application/json
required
object (stream_source_wowza)
created_at
string <date-time>

The date and time that the Wowza stream source was created.

id
string

The unique alphanumeric string that identifies the Wowza stream source.

name
string

A descriptive name for the Wowza stream source. Maximum 255 characters.

primary_url
string

The origin URL where you send your source stream.

state
string

The current state of the Wowza stream source.

Enum: "started" "stopped" "error"
stream_name
string

The name of the stream that you can use to configure the source encoder to connect to the Wowza stream source.

updated_at
string <date-time>

The date and time that the Wowza stream source was updated.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

patch/stream_sources/wowza/{id}
Request samples
application/json
{
  • "stream_source_wowza": {
    }
}
Response samples
application/json
{
  • "stream_source_wowza": {
    }
}

Delete a Wowza stream source

(Available from version 1.4) This operation deletes a Wowza stream source.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the Wowza stream source.

Responses
204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

delete/stream_sources/wowza/{id}
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WV_HOST}/api/v1.9/stream_sources/wowza/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": {
    }
}
Copyright © Wowza Video. All right reserved.