Stream Targets

Operations related to stream targets. A stream target is a destination for a stream. Stream targets can be Wowza Streaming Cloud edge resources; custom, external destinations; or ultra low latency target destinations.

Wowza CDN on Akamai Stream Targets

Wowza CDN on Akamai stream targets use the Wowza CDN to distribute streams to players. When you create a live stream in the API, a Wowza CDN on Akamai stream target is created automatically. In contrast, you can use /stream_targets/akamai endpoints to manually create Wowza CDN on Akamai stream targets and associate them with transcoders. With Wowza CDN on Akamai stream targets, you can use geo-blocking to control locations where your stream can be viewed, and you can use token authentication to restrict access to streams. Advanced properties are available for Wowza CDN on Akamai stream targets that deliver HLS streams through the akamai_cupertino provider.

Custom Stream Targets

Custom stream targets connect to external CDNs to deliver streams to viewers. You manually create custom stream targets and associate them to a transcoder. You can configure advanced properties for custom stream targets that deliver HLS streams through the akamai_cupertino provider.

Ultra Low Latency Stream Targets

Ultra low latency stream targets allow you to configure a source encoder to send a stream directly to a stream target and then onto a player or app for playback. You don't need to associate this type of stream target with live streams or transcoders. See Get started with ultra low latency streaming using the Wowza Streaming Cloud REST API to learn more.

Note: As of January 5, 2021, the ultra low latency (ULL) feature will be sunset, and existing ULL targets will no longer function. Click here to learn more about Wowza’s future plans for low latency streaming.

Wowza CDN on Fastly Stream Targets

Wowza CDN on Fastly stream targets leverage the Fastly CDN to distribute streams to players. A separate Fastly subscription isn't required because the Fastly CDN is integrated directly into Wowza Streaming Cloud.

Fetch all stream targets

This operation lists limited details for custom stream targets, ultra low latency stream targets, Wowza CDN on Akamai stream targets, and Wowza CDN on Fastly stream targets. For detailed information, fetch a single stream target of a specific type.

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

The date and time that the stream target was created.

id
string

The unique alphanumeric string that identifies the stream target.

name
string

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

type
string
Enum: "wowza" "custom" "ull" "fastly"

wowza is a Wowza CDN target; custom is an external, third-party destination; ull is an ultra low latency stream target; and fastly is a Wowza CDN on Fastly target.

updated_at
string <date-time>

The date and time that the stream target 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/beta/stream_targets"

Response samples

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

Create a custom stream target

This operation creates a custom stream target for an external, third-party destination.

Request Body schema: application/json

Provide the details of the custom stream target to create in the body of the request.

required
object (stream_target_custom)
name
required
string

A descriptive name for the custom stream target. Maximum 255 characters.

primary_url
required
string

The primary RTMP ingest URL. Hostnames can't contain underscores.

provider
required
string
Enum: "akamai" "akamai_cupertino" "akamai_rtmp" "limelight" "rtmp" "rtmps" "ustream"

The CDN for the target. Values can be appended with _mock to use in the sandbox environment.

stream_name
required
string

The name of the stream as defined in the target's ingestion settings. The protocol, host name, and path components of the stream name URL must be 255 characters or less. The query strings and parameter components of the stream name URL must be 1024 characters or less.

backup_url
string

Only for custom stream targets whose provider is not akamai_cupertino. The backup RTMP ingest URL of the custom stream target.

hds_playback_url
string

Only for custom stream targets whose provider is not akamai_cupertino. The web address that the target uses to play HDS streams.

hls_playback_url
string

The web address that the target uses to play HLS streams.

password
string

Only for custom stream targets whose provider is not akamai_cupertino. A username must also be present. The password associated with the target username for RTMP authentication.

rtmp_playback_url
string

The web address that the custom stream target uses to play RTMP streams.

username
string

Only for custom stream targets whose provider is not akamai_cupertino. The username or ID that the target uses for RTMP authentication.

Responses

Response Schema: application/json
object (stream_target_custom)
backup_url
string

Only for custom stream targets whose provider is not akamai_cupertino. The backup ingest URL for a custom stream target.

created_at
string <date-time>

The date and time that the custom stream target was created.

hds_playback_url
string

Only for custom stream targets whose provider is not akamai_cupertino. The web address that the custom stream target uses to play HDS streams.

hls_playback_url
string

The web address that the custom stream target uses to play HLS streams.

id
string

The unique alphanumeric string that identifies the custom stream target.

name
string

A descriptive name for the custom stream target. Maximum 255 characters.

password
string

Only for custom stream targets whose provider is not akamai_cupertino. A username must also be present. The password associated with the target username for RTMP authentication.

primary_url
string

The primary ingest URL of the custom stream target.

provider
string

The CDN for the target. Values can be appended with _mock to use in the sandbox environment.

rtmp_playback_url
string

The web address that the custom stream target uses to play RTMP streams.

stream_name
string

The name of the stream being ingested into the target.

updated_at
string <date-time>

The date and time that the custom stream target was updated.

username
string

Only for custom stream targets whose provider is not akamai_cupertino. The username or ID that the target uses for RTMP authentication.

Request samples

Content type
application/json
{
  • "stream_target_custom":
    {
    }
}

Response samples

Content type
application/json
{
  • "stream_target_custom":
    {
    }
}

Fetch all custom stream targets

This operation lists limited details for all of your custom stream targets. For detailed information, fetch a single custom stream target.

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

The date and time that the custom stream target was created.

id
string

The unique alphanumeric string that identifies the custom stream target.

name
string

A descriptive name for the custom stream target. Maximum 255 characters.

updated_at
string <date-time>

The date and time that the custom stream target 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/beta/stream_targets/custom"

Response samples

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

Fetch a custom stream target

This operation shows the details of a specific custom stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the custom stream target.

Responses

Response Schema: application/json
object (stream_target_custom)
backup_url
string

Only for custom stream targets whose provider is not akamai_cupertino. The backup ingest URL for a custom stream target.

created_at
string <date-time>

The date and time that the custom stream target was created.

hds_playback_url
string

Only for custom stream targets whose provider is not akamai_cupertino. The web address that the custom stream target uses to play HDS streams.

hls_playback_url
string

The web address that the custom stream target uses to play HLS streams.

id
string

The unique alphanumeric string that identifies the custom stream target.

name
string

A descriptive name for the custom stream target. Maximum 255 characters.

password
string

Only for custom stream targets whose provider is not akamai_cupertino. A username must also be present. The password associated with the target username for RTMP authentication.

primary_url
string

The primary ingest URL of the custom stream target.

provider
string

The CDN for the target. Values can be appended with _mock to use in the sandbox environment.

rtmp_playback_url
string

The web address that the custom stream target uses to play RTMP streams.

stream_name
string

The name of the stream being ingested into the target.

updated_at
string <date-time>

The date and time that the custom stream target was updated.

username
string

Only for custom stream targets whose provider is not akamai_cupertino. The username or ID that the target uses for RTMP authentication.

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/beta/stream_targets/custom/2adffc17"

Response samples

Content type
application/json
{
  • "stream_target_custom":
    {
    }
}

Update a custom stream target

This operation updates a custom stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the custom stream target.

Request Body schema: application/json

Provide the details of the custom stream target to update in the body of the request.

required
object (stream_target_custom)
backup_url
string

Only for custom stream targets whose provider is not akamai_cupertino. The backup RTMP ingest URL of the custom stream target.

hds_playback_url
string

Only for custom stream targets whose provider is not akamai_cupertino. The web address that the target uses to play HDS streams.

hls_playback_url
string

The web address that the target uses to play HLS streams.

name
string

A descriptive name for the custom stream target. Maximum 255 characters.

password
string

Only for custom stream targets whose provider is not akamai_cupertino. A username must also be present. The password associated with the target username for RTMP authentication.

primary_url
string

The primary RTMP ingest URL. Hostnames can't contain underscores.

provider
string
Enum: "akamai" "akamai_cupertino" "akamai_rtmp" "limelight" "rtmp" "ustream"

The CDN for the target. Values can be appended with _mock to use in the sandbox environment.

rtmp_playback_url
string

The web address that the custom stream target uses to play RTMP streams.

stream_name
string

The name of the stream as defined in the target's ingestion settings. The protocol, host name, and path components of the stream name URL must be 255 characters or less. The query strings and parameter components of the stream name URL must be 1024 characters or less.

username
string

Only for custom stream targets whose provider is not akamai_cupertino. The username or ID that the target uses for RTMP authentication.

Responses

Response Schema: application/json
object (stream_target_custom)
backup_url
string

Only for custom stream targets whose provider is not akamai_cupertino. The backup ingest URL for a custom stream target.

created_at
string <date-time>

The date and time that the custom stream target was created.

hds_playback_url
string

Only for custom stream targets whose provider is not akamai_cupertino. The web address that the custom stream target uses to play HDS streams.

hls_playback_url
string

The web address that the custom stream target uses to play HLS streams.

id
string

The unique alphanumeric string that identifies the custom stream target.

name
string

A descriptive name for the custom stream target. Maximum 255 characters.

password
string

Only for custom stream targets whose provider is not akamai_cupertino. A username must also be present. The password associated with the target username for RTMP authentication.

primary_url
string

The primary ingest URL of the custom stream target.

provider
string

The CDN for the target. Values can be appended with _mock to use in the sandbox environment.

rtmp_playback_url
string

The web address that the custom stream target uses to play RTMP streams.

stream_name
string

The name of the stream being ingested into the target.

updated_at
string <date-time>

The date and time that the custom stream target was updated.

username
string

Only for custom stream targets whose provider is not akamai_cupertino. The username or ID that the target uses for RTMP authentication.

Request samples

Content type
application/json
{
  • "stream_target_custom":
    {
    }
}

Response samples

Content type
application/json
{
  • "stream_target_custom":
    {
    }
}

Delete a custom stream target

This operation deletes a custom stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the custom stream target.

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/beta/stream_targets/custom/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":
    {
    }
}

Create a Wowza CDN on Fastly stream target

(Available from version 1.4) This operation creates a Wowza CDN on Fastly stream target to deliver your stream using the Wowza CDN on Fastly.

Request Body schema: application/json

Provide the details of the Wowza CDN on Fastly stream target to create in the body of the request.

required
object (stream_target_fastly)
name
required
string

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

force_ssl_playback
boolean

If true, requires users to play the stream over HTTPS. If false, the default, users can play the stream over HTTPS or HTTP.

geoblock_enabled
boolean

If true, controls access to the stream from specific locations and, optionally, IP addresses. The default is false,

geoblock_by_location
string
Enum: "allow" "deny" "disabled"

Specifies whether to allow or deny access to the stream from specific locations. The default is disabled.

geoblock_country_codes
string

Required when geoblock_by_location is allow or deny. The locations affected by the geo-blocking. Enter a comma-separated list of capitalized two-letter ISO 3166-1 country codes. For a list, see ISO 3166-1 on Wikipedia.

geoblock_ip_override
string
Enum: "allow" "deny" "disabled"

Specifies whether specific IP addresses can override the locations that are allowed or restricted. allow permits access from IP addresses within a location that's been blocked, while deny restricts access from IP addresses within locations that are allowed. The default is disabled.

geoblock_ip_addresses
string

Required when geoblock_ip_override is allow or deny. Addresses that can access or restrict the stream even if they're within a specified geo-blocked location. Enter a comma-separated list of IPv4 and IPv6 IP addresses that always allow or deny streaming based on the geoblock_ip_override value.

token_auth_enabled
boolean

If true, token authentication protects the stream by ensuring that it's delivered only to authorized viewers and can't be shared by unauthorized links or player hijacking attacks. The default is false.

token_auth_shared_secret
string

The shared secret of the token authentication. Must contain only hexadecimal characters and be an even number of total characters not exceeding 32.

token_auth_playlist_only
boolean

If true, Wowza Streaming Cloud uses token authentication to protect the master playlist only and leaves individual media playlists and media segments unprotected. This feature enables playback compatibility with media players that don’t support the withCredentials property. It may also be useful when addressing token auth compatibility issues with specific browsers. The default is false.

Responses

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

The date and time that the stream target was created.

force_ssl_playback
boolean

If true, requires users to play the stream over HTTPS. If false, the default, users can play the stream over HTTPS or HTTP.

geoblock_enabled
boolean

If true, controls access to the stream from specific locations and, optionally, IP addresses. The default is false,

geoblock_by_location
string
Enum: "allow" "deny" "disabled"

Specifies whether to allow or deny access to the stream from specific locations. The default is disabled.

geoblock_country_codes
string

Required when geoblock_by_location is allow or deny. The locations affected by the geo-blocking. Enter a comma-separated list of capitalized two-letter ISO 3166-1 country codes. For a list, see ISO 3166-1 on Wikipedia.

geoblock_ip_override
string
Enum: "allow" "deny" "disabled"

Specifies whether specific IP addresses can override the locations that are allowed or restricted. allow permits access from IP addresses within a location that's been blocked, while deny restricts access from IP addresses within locations that are allowed. The default is disabled.

geoblock_ip_addresses
string

Required when geoblock_ip_override is allow or deny. Addresses that can access or restrict the stream even if they're within a specified geo-blocked location. Enter a comma-separated list of IPv4 and IPv6 IP addresses that always allow or deny streaming based on the geoblock_ip_override value.

id
string

The unique alphanumeric string that identifies the stream target.

name
string

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

playback_url
string

The web address that the target uses to play HLS streams.

state
string
Enum: "activated" "archived"

The state of the stream target.

stream_name
string

The name of the stream being ingested into the target.

token_auth_enabled
boolean

If true, token authentication protects the stream by ensuring that it's delivered only to authorized viewers and can't be shared by unauthorized links or player hijacking attacks. The default is false.

token_auth_shared_secret
string

The shared secret of the token authentication. Must contain only hexadecimal characters and be an even number of total characters not exceeding 32.

token_auth_playlist_only
boolean

If true, Wowza Streaming Cloud uses token authentication to protect the master playlist only and leaves individual media playlists and media segments unprotected. This feature enables playback compatibility with media players that don’t support the withCredentials property. It may also be useful when addressing token auth compatibility issues with specific browsers. The default is false.

updated_at
string <date-time>

The date and time that the stream target was updated.

Request samples

Content type
application/json
{
  • "stream_target_fastly":
    {
    }
}

Response samples

Content type
application/json
{
  • "stream_target_fastly":
    {
    }
}

Fetch all Wowza CDN on Fastly stream targets

(Available from version 1.4) This operation lists limited details for all of your Wowza CDN on Fastly stream targets. For detailed information, fetch a single target.

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

The date and time that the stream target was created.

id
string

The unique alphanumeric string that identifies the stream target.

name
string

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

updated_at
string <date-time>

The date and time that the stream target 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/beta/stream_targets/fastly"

Response samples

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

Fetch a Wowza CDN on Fastly stream target

(Available from version 1.4) This operation shows the details of a specific Wowza CDN on Fastly stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

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

The date and time that the stream target was created.

force_ssl_playback
boolean

If true, requires users to play the stream over HTTPS. If false, the default, users can play the stream over HTTPS or HTTP.

geoblock_enabled
boolean

If true, controls access to the stream from specific locations and, optionally, IP addresses. The default is false,

geoblock_by_location
string
Enum: "allow" "deny" "disabled"

Specifies whether to allow or deny access to the stream from specific locations. The default is disabled.

geoblock_country_codes
string

Required when geoblock_by_location is allow or deny. The locations affected by the geo-blocking. Enter a comma-separated list of capitalized two-letter ISO 3166-1 country codes. For a list, see ISO 3166-1 on Wikipedia.

geoblock_ip_override
string
Enum: "allow" "deny" "disabled"

Specifies whether specific IP addresses can override the locations that are allowed or restricted. allow permits access from IP addresses within a location that's been blocked, while deny restricts access from IP addresses within locations that are allowed. The default is disabled.

geoblock_ip_addresses
string

Required when geoblock_ip_override is allow or deny. Addresses that can access or restrict the stream even if they're within a specified geo-blocked location. Enter a comma-separated list of IPv4 and IPv6 IP addresses that always allow or deny streaming based on the geoblock_ip_override value.

id
string

The unique alphanumeric string that identifies the stream target.

name
string

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

playback_url
string

The web address that the target uses to play HLS streams.

state
string
Enum: "activated" "archived"

The state of the stream target.

stream_name
string

The name of the stream being ingested into the target.

token_auth_enabled
boolean

If true, token authentication protects the stream by ensuring that it's delivered only to authorized viewers and can't be shared by unauthorized links or player hijacking attacks. The default is false.

token_auth_shared_secret
string

The shared secret of the token authentication. Must contain only hexadecimal characters and be an even number of total characters not exceeding 32.

token_auth_playlist_only
boolean

If true, Wowza Streaming Cloud uses token authentication to protect the master playlist only and leaves individual media playlists and media segments unprotected. This feature enables playback compatibility with media players that don’t support the withCredentials property. It may also be useful when addressing token auth compatibility issues with specific browsers. The default is false.

updated_at
string <date-time>

The date and time that the stream target 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/beta/stream_targets/fastly/2adffc17"

Response samples

Content type
application/json
{
  • "stream_target_fastly":
    {
    }
}

Update a Wowza CDN on Fastly stream target

(Available from version 1.4) This operation updates a Wowza CDN on Fastly stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

Request Body schema: application/json

Provide the details of the Wowza CDN on Fastly stream target to update in the body of the request.

required
object (stream_target_fastly)
name
string

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

force_ssl_playback
boolean

If true, requires users to play the stream over HTTPS. If false, the default, users can play the stream over HTTPS or HTTP.

geoblock_enabled
boolean

If true, controls access to the stream from specific locations and, optionally, IP addresses. The default is false,

geoblock_by_location
string
Enum: "allow" "deny" "disabled"

Specifies whether to allow or deny access to the stream from specific locations. The default is disabled.

geoblock_country_codes
string

Required when geoblock_by_location is allow or deny. The locations affected by the geo-blocking. Enter a comma-separated list of capitalized two-letter ISO 3166-1 country codes. For a list, see ISO 3166-1 on Wikipedia.

geoblock_ip_override
string
Enum: "allow" "deny" "disabled"

Specifies whether specific IP addresses can override the locations that are allowed or restricted. allow permits access from IP addresses within a location that's been blocked, while deny restricts access from IP addresses within locations that are allowed. The default is disabled.

geoblock_ip_addresses
string

Required when geoblock_ip_override is allow or deny. Addresses that can access or restrict the stream even if they're within a specified geo-blocked location. Enter a comma-separated list of IPv4 and IPv6 IP addresses that always allow or deny streaming based on the geoblock_ip_override value.

token_auth_enabled
boolean

If true, token authentication protects the stream by ensuring that it's delivered only to authorized viewers and can't be shared by unauthorized links or player hijacking attacks. The default is false.

token_auth_shared_secret
string

The shared secret of the token authentication. Must contain only hexadecimal characters and be an even number of total characters not exceeding 32.

token_auth_playlist_only
boolean

If true, Wowza Streaming Cloud uses token authentication to protect the master playlist only and leaves individual media playlists and media segments unprotected. This feature enables playback compatibility with media players that don’t support the withCredentials property. It may also be useful when addressing token auth compatibility issues with specific browsers. The default is false.

Responses

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

The date and time that the stream target was created.

force_ssl_playback
boolean

If true, requires users to play the stream over HTTPS. If false, the default, users can play the stream over HTTPS or HTTP.

geoblock_enabled
boolean

If true, controls access to the stream from specific locations and, optionally, IP addresses. The default is false,

geoblock_by_location
string
Enum: "allow" "deny" "disabled"

Specifies whether to allow or deny access to the stream from specific locations. The default is disabled.

geoblock_country_codes
string

Required when geoblock_by_location is allow or deny. The locations affected by the geo-blocking. Enter a comma-separated list of capitalized two-letter ISO 3166-1 country codes. For a list, see ISO 3166-1 on Wikipedia.

geoblock_ip_override
string
Enum: "allow" "deny" "disabled"

Specifies whether specific IP addresses can override the locations that are allowed or restricted. allow permits access from IP addresses within a location that's been blocked, while deny restricts access from IP addresses within locations that are allowed. The default is disabled.

geoblock_ip_addresses
string

Required when geoblock_ip_override is allow or deny. Addresses that can access or restrict the stream even if they're within a specified geo-blocked location. Enter a comma-separated list of IPv4 and IPv6 IP addresses that always allow or deny streaming based on the geoblock_ip_override value.

id
string

The unique alphanumeric string that identifies the stream target.

name
string

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

playback_url
string

The web address that the target uses to play HLS streams.

state
string
Enum: "activated" "archived"

The state of the stream target.

stream_name
string

The name of the stream being ingested into the target.

token_auth_enabled
boolean

If true, token authentication protects the stream by ensuring that it's delivered only to authorized viewers and can't be shared by unauthorized links or player hijacking attacks. The default is false.

token_auth_shared_secret
string

The shared secret of the token authentication. Must contain only hexadecimal characters and be an even number of total characters not exceeding 32.

token_auth_playlist_only
boolean

If true, Wowza Streaming Cloud uses token authentication to protect the master playlist only and leaves individual media playlists and media segments unprotected. This feature enables playback compatibility with media players that don’t support the withCredentials property. It may also be useful when addressing token auth compatibility issues with specific browsers. The default is false.

updated_at
string <date-time>

The date and time that the stream target was updated.

Request samples

Content type
application/json
{
  • "stream_target_fastly":
    {
    }
}

Response samples

Content type
application/json
{}

Delete a Wowza CDN on Fastly stream target

(Available from version 1.4) This operation deletes a Wowza CDN on Fastly stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

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/beta/stream_targets/fastly/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 all VOD streams for a Fastly stream target

(Available from version 1.5) This operation shows the details of all VOD streams associated to a specific Fastly stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
required
Array of objects (vod_streams)
Array ()
id
string

The unique alphanumeric string that identifies the VOD stream.

name
string

A descriptive name for the VOD stream. Maximum 200 characters.

created_at
string

The date and time that the VOD stream was created.

updated_at
string

The date and time that the VOD stream 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/beta/stream_targets/fastly/2adffc17/vod_streams"

Response samples

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

Create an ultra low latency stream target

This operation creates an ultra low latency stream target.

Ultra low latency stream targets are available through subscription to Wowza Streaming Cloud with Ultra Low Latency.

Note: As of January 5, 2021, the ultra low latency (ULL) feature will be sunset, and existing ULL targets will no longer function. Click here to learn more about Wowza’s future plans for low latency streaming.

Request Body schema: application/json

Provide the details of the ultra low latency stream target to create in the body of the request.

required
object (stream_target_ull)
name
required
string

A descriptive name for the ultra low latency stream target. Maximum 255 characters.

source_delivery_method
required
string
Enum: "push" "pull"

The type of connection between the stream source and the ultra low latency stream target. push instructs the source to push the stream to the stream target. pull instructs the stream target to pull the stream from the source.

source_url
required
string

Only for ultra low latency stream targets whose source_delivery_method is pull. The URL of a source IP camera or encoder connecting to the stream target.

enable_hls
boolean

If true, creates an HLS URL for playback on iOS devices. The default is false. The HLS stream has the convertAMFData stream target property enabled by default.

enabled
boolean

If true (the default), the source stream is ready to be ingested. If false, the source stream won't be ingested by the target's origin server.

ingest_ip_whitelist
Array of strings

Only for ultra low latency stream targets whose source_delivery_method is push. An array of IP addresses in dot-decimal notation that can be used to connect to the target's origin server. Wildcards (*) are accepted for the final value in the IP address only.

region_override
string
Enum: "origin-hk-central1.cdn.wowza.com" "origin-jp-east1.cdn.wowza.com" "origin-nl-central1.cdn.wowza.com" "origin-us-central2.cdn.wowza.com" "null"

Only for ultra low latency stream targets whose source_delivery_method is pull. The location of the ultra low latency stream target's origin server. If unspecified, Wowza Streaming Cloud determines the optimal region for the origin server.

Responses

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

The date and time that the ultra low latency stream target was created.

connection_code
string

A six-character, alphanumeric string that allows the Wowza GoCoder app to send an encoded stream to an ultra low latency stream target. The code can be used once and expires 24 hours after it's created.

connection_code_expires_at
string <date-time>

The date and time that the connection_code expires.

enabled
boolean

If true (the default), the source stream is ready to be ingested. If false, the source stream won't be ingested by the target's origin server.

enable_hls
boolean

If true, creates an HLS URL for playback on iOS devices. The default is false. The HLS stream has the convertAMFData stream target property enabled by default.

id
string

The unique alphanumeric string that identifies the ultra low latency stream target.

ingest_ip_whitelist
Array of strings

Only for ultra low latency stream targets whose source_delivery_method is push. An array of IP addresses in dot-decimal notation that can be used to connect to the target's origin server. Wildcards (*) are accepted for the final value in the IP address only.

name
string

A descriptive name for the ultra low latency stream target. Maximum 255 characters.

object (Hash of playback URLs)

A hash of hls, wowz, and ws URLs that can be used by the player.

primary_url
string

Only for ultra low latency stream targets whose source_delivery_method is push.The primary ingest URL of the target.

region_override
string
Enum: "origin-hk-central1.cdn.wowza.com" "origin-jp-east1.cdn.wowza.com" "origin-nl-central1.cdn.wowza.com" "origin-us-central2.cdn.wowza.com" "null"

Only for ultra low latency stream targets whose source_delivery_method is pull. The location of the ultra low latency stream target's origin server. If unspecified, Wowza Streaming Cloud determines the optimal region for the origin server.

source_delivery_method
string
Enum: "push" "pull"

The type of connection between the stream source and the ultra low latency stream target. push instructs the source to push the stream to the stream target. pull instructs the stream target to pull the stream from the source.

source_url
string

Only for ultra low latency stream targets whose source_delivery_method is pull. The URL of a source IP camera or encoder connecting to the stream target.

state
string
Enum: "started" "stopped" "error"

The state of the ultra low latency stream target.

stream_name
string

The name of the stream being ingested into the target. Returned only for ultra low latency stream targets whose source_delivery_method is push.

updated_at
string <date-time>

The date and time that the ultra low latency stream target was updated.

Request samples

Content type
application/json
{
  • "stream_target_ull":
    {
    }
}

Response samples

Content type
application/json
{
  • "stream_target_ull":
    {
    }
}

Fetch all ultra low latency stream targets

This operation lists limited details for all of your ultra low latency stream targets. For detailed information, fetch a single ultra low latency stream target.

Ultra low latency stream targets are available through subscription to Wowza Streaming Cloud with Ultra Low Latency.

Note: As of January 5, 2021, the ultra low latency (ULL) feature will be sunset, and existing ULL targets will no longer function. Click here to learn more about Wowza’s future plans for low latency streaming.

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

The date and time that the ultra low latency stream target was created.

id
string

The unique alphanumeric string that identifies the ultra low latency stream target.

name
string

A descriptive name for the ultra low latency stream target. Maximum 255 characters.

updated_at
string <date-time>

The date and time that the ultra low latency stream target 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/beta/stream_targets/ull"

Response samples

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

Fetch all started ultra low latency stream targets

This operation lists limited details for all ultra low latency stream targets with a state of started.

Note: As of January 5, 2021, the ultra low latency (ULL) feature will be sunset, and existing ULL targets will no longer function. Click here to learn more about Wowza’s future plans for low latency streaming.

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

The date and time that the ultra low latency stream target was created.

id
string

The unique alphanumeric string that identifies the ultra low latency stream target.

name
string

A descriptive name for the ultra low latency stream target. Maximum 255 characters.

updated_at
string <date-time>

The date and time that the ultra low latency stream target 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/beta/stream_targets/ull/started"

Response samples

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

Fetch an ultra low latency stream target

This operation shows the details of a specific ultra low latency stream target.

Ultra low latency stream targets are available through subscription to Wowza Streaming Cloud with Ultra Low Latency.

Note: As of January 5, 2021, the ultra low latency (ULL) feature will be sunset, and existing ULL targets will no longer function. Click here to learn more about Wowza’s future plans for low latency streaming.

path Parameters
id
required
string

The unique alphanumeric string that identifies the ultra low latency stream target.

Responses

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

The date and time that the ultra low latency stream target was created.

connection_code
string

A six-character, alphanumeric string that allows the Wowza GoCoder app to send an encoded stream to an ultra low latency stream target. The code can be used once and expires 24 hours after it's created.

connection_code_expires_at
string <date-time>

The date and time that the connection_code expires.

enabled
boolean

If true (the default), the source stream is ready to be ingested. If false, the source stream won't be ingested by the target's origin server.

enable_hls
boolean

If true, creates an HLS URL for playback on iOS devices. The default is false. The HLS stream has the convertAMFData stream target property enabled by default.

id
string

The unique alphanumeric string that identifies the ultra low latency stream target.

ingest_ip_whitelist
Array of strings

Only for ultra low latency stream targets whose source_delivery_method is push. An array of IP addresses in dot-decimal notation that can be used to connect to the target's origin server. Wildcards (*) are accepted for the final value in the IP address only.

name
string

A descriptive name for the ultra low latency stream target. Maximum 255 characters.

object (Hash of playback URLs)

A hash of hls, wowz, and ws URLs that can be used by the player.

primary_url
string

Only for ultra low latency stream targets whose source_delivery_method is push.The primary ingest URL of the target.

region_override
string
Enum: "origin-hk-central1.cdn.wowza.com" "origin-jp-east1.cdn.wowza.com" "origin-nl-central1.cdn.wowza.com" "origin-us-central2.cdn.wowza.com" "null"

Only for ultra low latency stream targets whose source_delivery_method is pull. The location of the ultra low latency stream target's origin server. If unspecified, Wowza Streaming Cloud determines the optimal region for the origin server.

source_delivery_method
string
Enum: "push" "pull"

The type of connection between the stream source and the ultra low latency stream target. push instructs the source to push the stream to the stream target. pull instructs the stream target to pull the stream from the source.

source_url
string

Only for ultra low latency stream targets whose source_delivery_method is pull. The URL of a source IP camera or encoder connecting to the stream target.

state
string
Enum: "started" "stopped" "error"

The state of the ultra low latency stream target.

stream_name
string

The name of the stream being ingested into the target. Returned only for ultra low latency stream targets whose source_delivery_method is push.

updated_at
string <date-time>

The date and time that the ultra low latency stream target 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/beta/stream_targets/ull/2adffc17"

Response samples

Content type
application/json
{
  • "stream_target_ull":
    {
    }
}

Update an ultra low latency stream target

This operation updates an ultra low latency stream target.

Ultra low latency stream targets are available through subscription to Wowza Streaming Cloud with Ultra Low Latency.

Note: As of January 5, 2021, the ultra low latency (ULL) feature will be sunset, and existing ULL targets will no longer function. Click here to learn more about Wowza’s future plans for low latency streaming.

path Parameters
id
required
string

The unique alphanumeric string that identifies the ultra low latency stream target.

Request Body schema: application/json

Provide the details of the ultra low latency stream target to update in the body of the request.

required
object (stream_target_ull)
enabled
boolean

If true (the default), the source stream is ready to be ingested. If false, the source stream won't be ingested by the target's origin server.

ingest_ip_whitelist
Array of strings

Only for ultra low latency stream targets whose source_delivery_method is push. An array of IP addresses in dot-decimal notation that can be used to connect to the target's origin server. Wildcards (*) are accepted for the final value in the IP address only.

name
string

A descriptive name for the ultra low latency stream target. Maximum 255 characters.

source_url
string

Only for ultra low latency stream targets whose source_delivery_method is pull. The URL of a source IP camera or encoder connecting to the stream target.

region_override
string
Enum: "origin-hk-central1.cdn.wowza.com" "origin-jp-east1.cdn.wowza.com" "origin-nl-central1.cdn.wowza.com" "origin-us-central2.cdn.wowza.com" "null"

Only for ultra low latency stream targets whose source_delivery_method is pull. The location of the ultra low latency stream target's origin server. If unspecified, Wowza Streaming Cloud determines the optimal region for the origin server.

Responses

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

The date and time that the ultra low latency stream target was created.

connection_code
string

A six-character, alphanumeric string that allows the Wowza GoCoder app to send an encoded stream to an ultra low latency stream target. The code can be used once and expires 24 hours after it's created.

connection_code_expires_at
string <date-time>

The date and time that the connection_code expires.

enabled
boolean

If true (the default), the source stream is ready to be ingested. If false, the source stream won't be ingested by the target's origin server.

enable_hls
boolean

If true, creates an HLS URL for playback on iOS devices. The default is false. The HLS stream has the convertAMFData stream target property enabled by default.

id
string

The unique alphanumeric string that identifies the ultra low latency stream target.

ingest_ip_whitelist
Array of strings

Only for ultra low latency stream targets whose source_delivery_method is push. An array of IP addresses in dot-decimal notation that can be used to connect to the target's origin server. Wildcards (*) are accepted for the final value in the IP address only.

name
string

A descriptive name for the ultra low latency stream target. Maximum 255 characters.

object (Hash of playback URLs)

A hash of hls, wowz, and ws URLs that can be used by the player.

primary_url
string

Only for ultra low latency stream targets whose source_delivery_method is push.The primary ingest URL of the target.

region_override
string
Enum: "origin-hk-central1.cdn.wowza.com" "origin-jp-east1.cdn.wowza.com" "origin-nl-central1.cdn.wowza.com" "origin-us-central2.cdn.wowza.com" "null"

Only for ultra low latency stream targets whose source_delivery_method is pull. The location of the ultra low latency stream target's origin server. If unspecified, Wowza Streaming Cloud determines the optimal region for the origin server.

source_delivery_method
string
Enum: "push" "pull"

The type of connection between the stream source and the ultra low latency stream target. push instructs the source to push the stream to the stream target. pull instructs the stream target to pull the stream from the source.

source_url
string

Only for ultra low latency stream targets whose source_delivery_method is pull. The URL of a source IP camera or encoder connecting to the stream target.

state
string
Enum: "started" "stopped" "error"

The state of the ultra low latency stream target.

stream_name
string

The name of the stream being ingested into the target. Returned only for ultra low latency stream targets whose source_delivery_method is push.

updated_at
string <date-time>

The date and time that the ultra low latency stream target was updated.

Request samples

Content type
application/json
{
  • "stream_target_ull":
    {
    }
}

Response samples

Content type
application/json
{
  • "stream_target_ull":
    {
    }
}

Delete an ultra low latency stream target

This operation deletes an ultra low latency stream target.

Ultra low latency stream targets are available through subscription to Wowza Streaming Cloud with Ultra Low Latency.

Note: As of January 5, 2021, the ultra low latency (ULL) feature will be sunset, and existing ULL targets will no longer function. Click here to learn more about Wowza’s future plans for low latency streaming.

path Parameters
id
required
string

The unique alphanumeric string that identifies the ultra low latency stream target.

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/beta/stream_targets/ull/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":
    {
    }
}

Create a Wowza CDN on Akamai stream target

This operation creates a Wowza CDN on Akamai stream target for a Wowza CDN.

Request Body schema: application/json

Provide the details of the Wowza stream target to create in the body of the request.

required
object (stream_target_akamai)
name
required
string

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

location
required
string
Enum: "asia_pacific_australia" "asia_pacific_japan" "asia_pacific_s_korea" "asia_pacific_singapore" "asia_pacific_taiwan" "eu_belgium" "eu_germany" "eu_ireland" "south_america_brazil" "us_central_iowa" "us_east_s_carolina" "us_east_virginia" "us_west_california" "us_west_oregon"

Only for Wowza stream targets whose provider is not akamai_cupertino. Choose a location as close as possible to your video source.

provider
string
Enum: "akamai" "akamai_cupertino" "akamai_legacy_rtmp"

The CDN for the target. Values can be appended with _mock to use in the sandbox environment.

use_cors
boolean

Only for Wowza stream targets whose provider is akamai_cupertino. CORS, or cross-origin resource sharing, allows streams to be safely delivered across domains.

use_secure_ingest
boolean

Only for Wowza stream targets whose provider is akamai_cupertino. If true, generates a secure_ingest_query_param to securely deliver the stream from the transcoder to the provider.

Responses

Response Schema: application/json
required
object (stream_target_akamai)
backup_url
string

Only for Wowza stream targets whose provider is not akamai_cupertino. The backup RTMP ingest URL of the Wowza Stream Target.

connection_code
string

A six-character, alphanumeric string that allows Wowza Streaming Engine to send a transcoded stream to a Wowza stream target. The code can be used once and expires 24 hours after it's created.

connection_code_expires_at
string <date-time>

The date and time that the connection_code expires.

created_at
string <date-time>

The date and time that the stream target was created.

hds_playback_url
string

The web address that the target uses to play HDS streams.

hls_playback_url
string

Only for targets whose provider is akamai_cupertino. The web address that the target uses to play HLS streams.

id
string

The unique alphanumeric string that identifies the stream target.

location
string
Enum: "asia_pacific_australia" "asia_pacific_japan" "asia_pacific_s_korea" "asia_pacific_singapore" "asia_pacific_taiwan" "eu_belgium" "eu_germany" "eu_ireland" "south_america_brazil" "us_central_iowa" "us_east_s_carolina" "us_east_virginia" "us_west_california" "us_west_oregon"

Only for Wowza stream targets whose provider is not akamai_cupertino. Choose a location as close as possible to your video source.

name
string

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

primary_url
string

The primary ingest URL of the target.

provider
string

The CDN for the target.

secure_ingest_query_param
string

Only for targets whose use_secure_ingest is true. The query parameter needed for secure stream delivery between the transcoder and the target.

stream_name
string

The name of the stream being ingested into the target.

updated_at
string <date-time>

The date and time that the stream target was updated.

use_cors
boolean

Only for Wowza stream targets whose provider is akamai_cupertino. CORS, or cross-origin resource sharing, allows streams to be safely delivered across domains.

use_secure_ingest
boolean

Only for Wowza stream targets whose provider is akamai_cupertino. If true, generates a secure_ingest_query_param to securely deliver the stream from the transcoder to the provider.

Request samples

Content type
application/json
{
  • "stream_target_akamai":
    {
    }
}

Response samples

Content type
application/json
{}

Fetch all Wowza CDN on Akamai stream targets

This operation lists limited details for all of your Wowza CDN on Akamai stream targets. For detailed information, fetch a single Wowza CDN on Akamai stream target.

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

The date and time that the stream target was created.

id
string

The unique alphanumeric string that identifies the stream target.

name
string

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

updated_at
string <date-time>

The date and time that the stream target 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/beta/stream_targets/akamai"

Response samples

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

Fetch a Wowza CDN on Akamai stream target

This operation shows the details of a specific Wowza CDN on Akamai stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
required
object (stream_target_akamai)
backup_url
string

Only for Wowza stream targets whose provider is not akamai_cupertino. The backup RTMP ingest URL of the Wowza Stream Target.

connection_code
string

A six-character, alphanumeric string that allows Wowza Streaming Engine to send a transcoded stream to a Wowza stream target. The code can be used once and expires 24 hours after it's created.

connection_code_expires_at
string <date-time>

The date and time that the connection_code expires.

created_at
string <date-time>

The date and time that the stream target was created.

hds_playback_url
string

The web address that the target uses to play HDS streams.

hls_playback_url
string

Only for targets whose provider is akamai_cupertino. The web address that the target uses to play HLS streams.

id
string

The unique alphanumeric string that identifies the stream target.

location
string
Enum: "asia_pacific_australia" "asia_pacific_japan" "asia_pacific_s_korea" "asia_pacific_singapore" "asia_pacific_taiwan" "eu_belgium" "eu_germany" "eu_ireland" "south_america_brazil" "us_central_iowa" "us_east_s_carolina" "us_east_virginia" "us_west_california" "us_west_oregon"

Only for Wowza stream targets whose provider is not akamai_cupertino. Choose a location as close as possible to your video source.

name
string

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

primary_url
string

The primary ingest URL of the target.

provider
string

The CDN for the target.

secure_ingest_query_param
string

Only for targets whose use_secure_ingest is true. The query parameter needed for secure stream delivery between the transcoder and the target.

stream_name
string

The name of the stream being ingested into the target.

updated_at
string <date-time>

The date and time that the stream target was updated.

use_cors
boolean

Only for Wowza stream targets whose provider is akamai_cupertino. CORS, or cross-origin resource sharing, allows streams to be safely delivered across domains.

use_secure_ingest
boolean

Only for Wowza stream targets whose provider is akamai_cupertino. If true, generates a secure_ingest_query_param to securely deliver the stream from the transcoder to the provider.

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/beta/stream_targets/akamai/2adffc17"

Response samples

Content type
application/json
{}

Update a Wowza CDN on Akamai stream target

This operation updates a Wowza CDN on Akamai stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

Request Body schema: application/json

Provide the details of the Wowza stream target to update in the body of the request.

required
object (stream_target_akamai)
name
string

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

provider
string
Enum: "akamai" "akamai_cupertino" "akamai_legacy_rtmp"

The CDN for the target. Values can be appended with _mock to use in the sandbox environment.

Responses

Response Schema: application/json
required
object (stream_target_akamai)
backup_url
string

Only for Wowza stream targets whose provider is not akamai_cupertino. The backup RTMP ingest URL of the Wowza Stream Target.

connection_code
string

A six-character, alphanumeric string that allows Wowza Streaming Engine to send a transcoded stream to a Wowza stream target. The code can be used once and expires 24 hours after it's created.

connection_code_expires_at
string <date-time>

The date and time that the connection_code expires.

created_at
string <date-time>

The date and time that the stream target was created.

hds_playback_url
string

The web address that the target uses to play HDS streams.

hls_playback_url
string

Only for targets whose provider is akamai_cupertino. The web address that the target uses to play HLS streams.

id
string

The unique alphanumeric string that identifies the stream target.

location
string
Enum: "asia_pacific_australia" "asia_pacific_japan" "asia_pacific_s_korea" "asia_pacific_singapore" "asia_pacific_taiwan" "eu_belgium" "eu_germany" "eu_ireland" "south_america_brazil" "us_central_iowa" "us_east_s_carolina" "us_east_virginia" "us_west_california" "us_west_oregon"

Only for Wowza stream targets whose provider is not akamai_cupertino. Choose a location as close as possible to your video source.

name
string

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

primary_url
string

The primary ingest URL of the target.

provider
string

The CDN for the target.

secure_ingest_query_param
string

Only for targets whose use_secure_ingest is true. The query parameter needed for secure stream delivery between the transcoder and the target.

stream_name
string

The name of the stream being ingested into the target.

updated_at
string <date-time>

The date and time that the stream target was updated.

use_cors
boolean

Only for Wowza stream targets whose provider is akamai_cupertino. CORS, or cross-origin resource sharing, allows streams to be safely delivered across domains.

use_secure_ingest
boolean

Only for Wowza stream targets whose provider is akamai_cupertino. If true, generates a secure_ingest_query_param to securely deliver the stream from the transcoder to the provider.

Request samples

Content type
application/json
{
  • "stream_target_akamai":
    {
    }
}

Response samples

Content type
application/json
{}

Delete a Wowza CDN on Akamai stream target

This operation deletes a Wowza CDN on Akamai stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

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/beta/stream_targets/akamai/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":
    {
    }
}

Regenerate the connection code for any stream target

This operation regenerates the connection code of any kind of stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
required
object (stream_target)
connection_code
string

A six-character, alphanumeric string that allows select encoders, such as Wowza Streaming Engine or the Wowza GoCoder app, to send an encoded stream to a stream target in Wowza Streaming Cloud. The code can be used once and expires 24 hours after it's created.

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 "PUT" \
  "${WSC_HOST}/api/beta/stream_targets/2adffc17/regenerate_connection_code"

Response samples

Content type
application/json
{
  • "stream_target":
    {
    }
}

Configure a property for a stream target

This operation configures a property for a stream target. Properties are available for a custom stream target or Wowza stream target whose provider is akamai_cupertino. Some properties, as noted in the key descriptions, can also be applied to Wowza CDN on Fastly stream targets. For more information see Set advanced properties with the Wowza Streaming Cloud REST API.

path Parameters
stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

Request Body schema: application/json

Provide the details of the property to configure in the body of the request.

required
object (property)
key
required
string
Enum: "chunkSize" "convertAMFData" "sendSSL" "playSSL" "playlistSeconds" "redundantChunklists" "relativePlaylists"

chunkSize defines the duration of the time-based audio and video chunks that Wowza Streaming Cloud delivers to the target. chunkSize can be used with Wowza CDN on Fastly stream targets.

convertAMFData determines whether Wowza Streaming Cloud converts incoming AMF data into ID3 tags. convertAMFData can be used with Wowza CDN on Fastly stream targets.

sendSSL determines whether Wowza Streaming Cloud sends the stream from the transcoder to the target by using SSL (HTTPS).

playSSL determines whether Wowza Streaming Cloud sends the stream from the target to the player by using SSL (HTTPS).

playlistSeconds defines the maximum allowable length of the playlist. playlistSeconds can be used with Wowza CDN on Fastly stream targets.

redundantChunklists determines whether Wowza Streaming Cloud creates redundant chunklists within a playlist. If a primary chunklist within a playlist fails, players that support redundancy during playback can switch to the redundant chunklist.

Note: Enabling redundantChunklists increases playback reliability but doubles egress data usage and associated charges.

relativePlaylists allows the viewer to watch the stream over HTTP and HTTPS, whichever protocol their browser calls. relativePlaylists can be used with Wowza CDN on Fastly stream targets.

section
required
string
Enum: "hls" "playlist"

The section of the stream target configuration table that contains the property.

The valid value for chunkSize, convertAMFData, and sendSSL is hls.

The valid value for playSSL, playlistSeconds, redundantChunklists, and relativePlaylists is playlist.

value
required
string

For chunkSize, use 2, 4, 6, 8, or 10, expressed as a string or an integer.

For convertAMFData, sendSSL, playSSL, redundantChunklists, and relativePlaylists use true or false, expressed as a string or a Boolean.

For playlistSeconds, use any value between 6 and 28800 (8 hours), expressed as a string or an integer.

Responses

Response Schema: application/json
required
object (stream_target_property)
key
string
Enum: "chunkSize" "convertAMFData" "sendSSL" "playSSL" "playlistSeconds" "redundantChunklists" "relativePlaylists"

chunkSize defines the duration of the time-based audio and video chunks that Wowza Streaming Cloud delivers to the target. chunkSize can be used with Wowza CDN on Fastly stream targets.

convertAMFData determines whether Wowza Streaming Cloud converts incoming AMF data into ID3 tags. convertAMFData can be used with Wowza CDN on Fastly stream targets.

sendSSL determines whether Wowza Streaming Cloud sends the stream from the transcoder to the target by using SSL (HTTPS).

playSSL determines whether Wowza Streaming Cloud sends the stream from the target to the player by using SSL (HTTPS).

playlistSeconds defines the maximum allowable length of the playlist. playlistSeconds can be used with Wowza CDN on Fastly stream targets.

redundantChunklists determines whether Wowza Streaming Cloud creates redundant chunklists within a playlist. If a primary chunklist within a playlist fails, players that support redundancy during playback can switch to the redundant chunklist.

Note: Enabling redundantChunklists increases playback reliability but doubles egress data usage and associated charges.

relativePlaylists allows the viewer to watch the stream over HTTP and HTTPS, whichever protocol their browser calls. relativePlaylists can be used with Wowza CDN on Fastly stream targets.

section
string
Enum: "hls" "playlist"

The section of the stream target configuration table that contains the property.

The valid value for chunkSize, convertAMFData, and sendSSL is hls.

The valid value for playSSL, playlistSeconds, redundantChunklists, and relativePlaylists is playlist.

value
string

Valid values for chunkSize are the integers 2, 4, 6, 8, and 10.

Valid values for convertAMFData, sendSSL, playSSL, redundantChunklists, and relativePlaylists are the Booleans true and false.

Valid values for playlistSeconds are any integer between 6 and 28800 (8 hours).

Request samples

Content type
application/json
{
  • "property":
    {
    }
}

Response samples

Content type
application/json
{
  • "property":
    {
    }
}

Fetch all properties of a stream target

This operation shows the details of all of the properties assigned to a specific stream target. Properties can be applied to a custom stream target or to a Wowza stream target whose provider is akamai_cupertino. Some properties, as noted in the key descriptions, can also be applied to Wowza CDN on Fastly stream targets.

path Parameters
stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
required
Array of objects (stream_target_property)
Array ()
key
string
Enum: "chunkSize" "convertAMFData" "sendSSL" "playSSL" "playlistSeconds" "redundantChunklists" "relativePlaylists"

chunkSize defines the duration of the time-based audio and video chunks that Wowza Streaming Cloud delivers to the target. chunkSize can be used with Wowza CDN on Fastly stream targets.

convertAMFData determines whether Wowza Streaming Cloud converts incoming AMF data into ID3 tags. convertAMFData can be used with Wowza CDN on Fastly stream targets.

sendSSL determines whether Wowza Streaming Cloud sends the stream from the transcoder to the target by using SSL (HTTPS).

playSSL determines whether Wowza Streaming Cloud sends the stream from the target to the player by using SSL (HTTPS).

playlistSeconds defines the maximum allowable length of the playlist. playlistSeconds can be used with Wowza CDN on Fastly stream targets.

redundantChunklists determines whether Wowza Streaming Cloud creates redundant chunklists within a playlist. If a primary chunklist within a playlist fails, players that support redundancy during playback can switch to the redundant chunklist.

Note: Enabling redundantChunklists increases playback reliability but doubles egress data usage and associated charges.

relativePlaylists allows the viewer to watch the stream over HTTP and HTTPS, whichever protocol their browser calls. relativePlaylists can be used with Wowza CDN on Fastly stream targets.

section
string
Enum: "hls" "playlist"

The section of the stream target configuration table that contains the property.

The valid value for chunkSize, convertAMFData, and sendSSL is hls.

The valid value for playSSL, playlistSeconds, redundantChunklists, and relativePlaylists is playlist.

value
string

Valid values for chunkSize are the integers 2, 4, 6, 8, and 10.

Valid values for convertAMFData, sendSSL, playSSL, redundantChunklists, and relativePlaylists are the Booleans true and false.

Valid values for playlistSeconds are any integer between 6 and 28800 (8 hours).

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/beta/stream_targets/2adffc17/properties"

Response samples

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

Fetch a property of a stream target

This operation shows the details of a specific property assigned to a specific stream target. Properties can be applied to a custom stream target or to a Wowza stream target whose provider is akamai_cupertino. Some properties, as noted in the key descriptions, can also be applied to Wowza CDN on Fastly stream targets.

path Parameters
stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

id
required
string

The unique string that identifies the stream target property. The string contains the section and the key, connected by a dash. For example, hls-chunkSize.

Responses

Response Schema: application/json
required
object (stream_target_property)
key
string
Enum: "chunkSize" "convertAMFData" "sendSSL" "playSSL" "playlistSeconds" "redundantChunklists" "relativePlaylists"

chunkSize defines the duration of the time-based audio and video chunks that Wowza Streaming Cloud delivers to the target. chunkSize can be used with Wowza CDN on Fastly stream targets.

convertAMFData determines whether Wowza Streaming Cloud converts incoming AMF data into ID3 tags. convertAMFData can be used with Wowza CDN on Fastly stream targets.

sendSSL determines whether Wowza Streaming Cloud sends the stream from the transcoder to the target by using SSL (HTTPS).

playSSL determines whether Wowza Streaming Cloud sends the stream from the target to the player by using SSL (HTTPS).

playlistSeconds defines the maximum allowable length of the playlist. playlistSeconds can be used with Wowza CDN on Fastly stream targets.

redundantChunklists determines whether Wowza Streaming Cloud creates redundant chunklists within a playlist. If a primary chunklist within a playlist fails, players that support redundancy during playback can switch to the redundant chunklist.

Note: Enabling redundantChunklists increases playback reliability but doubles egress data usage and associated charges.

relativePlaylists allows the viewer to watch the stream over HTTP and HTTPS, whichever protocol their browser calls. relativePlaylists can be used with Wowza CDN on Fastly stream targets.

section
string
Enum: "hls" "playlist"

The section of the stream target configuration table that contains the property.

The valid value for chunkSize, convertAMFData, and sendSSL is hls.

The valid value for playSSL, playlistSeconds, redundantChunklists, and relativePlaylists is playlist.

value
string

Valid values for chunkSize are the integers 2, 4, 6, 8, and 10.

Valid values for convertAMFData, sendSSL, playSSL, redundantChunklists, and relativePlaylists are the Booleans true and false.

Valid values for playlistSeconds are any integer between 6 and 28800 (8 hours).

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/beta/stream_targets/2adffc17/properties/hls-chunkSize"

Response samples

Content type
application/json
{
  • "property":
    {
    }
}

Delete a stream target property

This operation removes a property from a stream target.

path Parameters
stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

id
required
string

The unique string that identifies the stream target property. The string contains the section and the key, connected by a dash. For example, hls-chunkSize.

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/beta/stream_targets/2adffc17/properties/hls-chunkSize"

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 current health metrics for an active ultra low latency stream target

This operation returns a snapshot of the current connection and throughput details for an active ultra low latency stream target. The interval for current metrics is 30 seconds from the moment of the query.

<Note: Ultra low latency stream targets are available through subscription to Wowza Streaming Cloud with Ultra Low Latency.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
id
string

The unique alphanumeric string that identifies the stream target.

object (stream_target_metrics)

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/beta/stream_targets/2adffc17/metrics/current"

Response samples

Content type
application/json
{
  • "stream_target":
    {
    }
}

Fetch historic health metrics for an ultra low latency stream target

This operation shows historic connection and throughput details for an ultra low latency stream target.

Note: Ultra low latency stream targets are available through subscription to Wowza Streaming Cloud with Ultra Low Latency.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

query Parameters
from
string

The start of the range of time used to aggregate the metrics. Express the value by using the ISO 8601 standard of YYYY-MM-DDTHH:MM:SSZ where HH is a 24-hour clock in UTC.

to
string

The end of the range of time used to aggregate the metrics. Express the value by using the ISO 8601 standard of YYYY-MM-DDTHH:MM:SSZ where HH is a 24-hour clock in UTC.

interval
string
Enum: "second" "minute" "hour" "day" "month" "#s" "#m" "#h" "#d"

The length of time for a block of metrics. The default is 10m (10 minutes).

Responses

Response Schema: application/json
id
string

The unique alphanumeric string that identifies the stream target.

interval
string

The length of time for a block of metrics. The default is 10m (10 minutes).

Array of objects (stream_target_metrics)

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/beta/stream_targets/2adffc17/metrics/historic"

Response samples

Content type
application/json
{
  • "stream_target":
    {
    }
}
➔ Next to Recordings