Stream Targets

Operations related to stream targets. A stream target is a destination for a stream. Stream targets can be Wowza Video edge resources; custom, external destinations target destinations.

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 Video. When you create a live stream in the API, a Wowza CDN on Fastly stream target is created automatically. In contrast, you can use /stream_targets/fastly endpoints to manually create Wowza CDN on Fastly stream targets and associate them with transcoders. With Wowza CDN on Fastly 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 configuration properties are available for Wowza CDN on Fastly stream targets.

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.

Fetch all stream targets

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

Request

query Parameters

assignable	boolean Returns stream targets that are assignable to an output. If true, all assignable stream targets are included in the response. If the parameter isn't used, all assignable and unassignable stream targets are included in the response. Example: api.video.wowza.com/api/v2.0/stream_targets?assignable=true
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_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.
state	string The state of the stream target. Enum: "activated" "archived"
type	string custom is an external, third-party destination and fastly is a Wowza CDN on Fastly target. Enum: "custom" "fastly"
updated_at	string <date-time> The date and time that the stream target was updated.

401

Unauthorized

get/stream_targets

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/stream_targets"

Response samples

application/json

{"stream_targets": [{"created_at": "2020-01-29T17:16:22.007Z",
"id": "qvvjyjjk",
"name": "My RTMP Stream Target",
"state": "deactivated",
"type": "wowza",
"updated_at": "2020-01-31T02:05:18.007Z"
},
{"created_at": "2020-01-28T17:16:22.007Z",
"id": "j75mlh3v",
"name": "My HLS Push Stream Target",
"state": "activated",
"type": "custom",
"updated_at": "2020-01-31T11:02:53.007Z"
}
]
}

Create a custom stream target

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

Request

Request Body schema: application/json
required

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 The CDN for the target. Enum: "akamai_cupertino" "rtmp" "rtmps"
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 The backup RTMP ingest URL of the custom stream target. Not all providers or third-party CDNs provide backup URLs. Not for use with the akamai_cuptertino custom provider. Note: When both the primary and backup URLs are used, Wowza Video sends the stream to both URLs, allowing a provider or 3rd party CDN to improve reliability and prevent playback disruption. If you want to use both URLs, make sure you add the stream target to the output rendition twice, once with use_stream_target_backup_url as false (the default) and once with use_stream_target_backup_url as true. See POST /transcoders/[ID]/outputs/[ID]/output_stream_targets for more information. Example: `"backup_url": "rtmp://b.ep337857.i.akamaientrypoint.net/EntryPoint"`
	object (Hash of playback URLs) Web addresses that the target uses to play streams. Available from version 1.7. Example: See response body sample
password	string A username must also be present. The password associated with the target username for RTMP authentication. Not for use with the akamai_cupertino custom provider. Example: `"password": "cb1e77e98d"`
username	string The username or ID that the target uses for RTMP authentication. Not for use with the akamai_cupertino custom provider.

Responses

201

Success

Response Schema: application/json

object (stream_target_custom)

backup_url	string The backup ingest URL for a custom stream target. Not for use with the akamai_cupertino custom provider.
created_at	string <date-time> The date and time that the custom stream target was created.
delivery_protocols	Array of strings An array of the delivery protocols available for this stream target. Available from version 1.7.
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 A username must be present. The password associated with the target username for RTMP authentication. Not for use with the akamai_cupertino custom provider.
	object Web addresses that the target uses to play streams. Available from version 1.7.
primary_url	string The primary ingest URL of the custom stream target.
provider	string The CDN for 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 custom stream target was updated.
username	string The username or ID that the target uses for RTMP authentication. Not for use with the akamai_cupertino custom provider.

401

Unauthorized

422

Unprocessable Entity

post/stream_targets/custom

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"stream_target_custom": {"name": "My Custom Stream Target",
"primary_url": "rtmp://p.ep123456.i.akamaientrypoint.net/EntryPoint",
"provider": "rtmp",
"stream_name": "c8467d50@123456"
}
}

Response samples

application/json

{"stream_target_custom": {"created_at": "2020-01-28T17:16:22.011Z",
"delivery_protocols": ["rtmp"
],
"id": "RMS45lfvx",
"name": "My Custom Stream Target",
"playback_urls": {"rtmp": [{"name": "default",
"url": "rtmp://cp123456.live.edgefcs.net/live/[EVENT]@654321"
}
]
},
"primary_url": "rtmp://p.ep123456.i.akamaientrypoint.net/EntryPoint",
"provider": "rtmp",
"stream_name": "c8467d50@123456",
"updated_at": "2020-01-30T19:14:11.011Z"
}
}

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.

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

401

Unauthorized

get/stream_targets/custom

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/stream_targets/custom"

Response samples

application/json

{"stream_targets_custom": [{"created_at": "2020-01-28T17:16:22.008Z",
"id": "RMS45lfvx",
"name": "My Custom Stream Target",
"updated_at": "2020-01-31T00:44:50.008Z"
},
{"created_at": "2020-01-28T17:16:22.008Z",
"id": "ABC45lxyz",
"name": "My Second Custom Stream Target",
"updated_at": "2020-01-31T02:05:33.008Z"
}
]
}

Fetch a custom stream target

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

Request

path Parameters

required

string

The unique alphanumeric string that identifies the custom stream target.

Responses

200

Success

Response Schema: application/json

object (stream_target_custom)

backup_url	string The backup ingest URL for a custom stream target. Not for use with the akamai_cupertino custom provider.
created_at	string <date-time> The date and time that the custom stream target was created.
delivery_protocols	Array of strings An array of the delivery protocols available for this stream target. Available from version 1.7.
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 A username must be present. The password associated with the target username for RTMP authentication. Not for use with the akamai_cupertino custom provider.
	object Web addresses that the target uses to play streams. Available from version 1.7.
primary_url	string The primary ingest URL of the custom stream target.
provider	string The CDN for 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 custom stream target was updated.
username	string The username or ID that the target uses for RTMP authentication. Not for use with the akamai_cupertino custom provider.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/stream_targets/custom/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/stream_targets/custom/2adffc17"

Response samples

application/json

{"stream_target_custom": {"created_at": "2020-01-28T17:16:22.011Z",
"delivery_protocols": ["rtmp"
],
"id": "RMS45lfvx",
"name": "My Custom Stream Target",
"playback_urls": {"rtmp": [{"name": "default",
"url": "rtmp://cp123456.live.edgefcs.net/live/[EVENT]@654321"
}
]
},
"primary_url": "rtmp://p.ep123456.i.akamaientrypoint.net/EntryPoint",
"provider": "rtmp",
"stream_name": "c8467d50@123456",
"updated_at": "2020-01-30T19:14:11.011Z"
}
}

Update a custom stream target

This operation updates a custom stream target.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the custom stream target.

Request Body schema: application/json
required

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

required

object (stream_target_custom)

backup_url	string The backup RTMP ingest URL of the custom stream target. Not all providers or third-party CDNs provide backup URLs. Not for use with the akamai_cupertino custom provider. Note: When both the primary and backup URLs are used, Wowza Video sends the stream to both URLs, allowing a provider or 3rd party CDN to improve reliability and prevent playback disruption. If you want to use both URLs, make sure you add the stream target to the output rendition twice, once with use_stream_target_backup_url as false (the default) and once with use_stream_target_backup_url as true. See POST /transcoders/[ID]/outputs/[ID]/output_stream_targets for more information. Example: `"backup_url": "rtmp://b.ep337857.i.akamaientrypoint.net/EntryPoint"`
name	string A descriptive name for the custom stream target. Maximum 255 characters. Example: `"name": "My Updated Custom Stream Target"`
password	string A username must be present. The password associated with the target username for RTMP authentication. Not for use with the akamai_cupertino custom provider. Note: If you want to clear both username and password for RTMP authentication, send an empty string for both username and password fields. Example: `"password": "cb1e77e98d"`
	object (Hash of playback URLs) Web addresses that the target uses to play streams. Available from version 1.7. Example: See response body sample
primary_url	string The primary RTMP ingest URL. Hostnames can't contain underscores. Example: `"primary_url": "rtmp://b.ep337857.i.akamaientrypoint.net/EntryPoint"`
provider	string The CDN for the target. Example: `"provider": "akamai_cupertino"` Enum: "akamai_cupertino" "rtmp" "rtmps"
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. Example: `"stream_name": "c8467d50@337857"`
username	string The username or ID that the target uses for RTMP authentication. Not for use with the akamai_cupertino custom provider. Note: If you want to clear both username and password for RTMP authentication, send an empty string for both username and password fields. Example: `"username": "319699"`

Responses

200

Success

Response Schema: application/json

object (stream_target_custom)

backup_url	string The backup ingest URL for a custom stream target. Not for use with the akamai_cupertino custom provider.
created_at	string <date-time> The date and time that the custom stream target was created.
delivery_protocols	Array of strings An array of the delivery protocols available for this stream target. Available from version 1.7.
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 A username must be present. The password associated with the target username for RTMP authentication. Not for use with the akamai_cupertino custom provider.
	object Web addresses that the target uses to play streams. Available from version 1.7.
primary_url	string The primary ingest URL of the custom stream target.
provider	string The CDN for 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 custom stream target was updated.
username	string he username or ID that the target uses for RTMP authentication. Not for use with the akamai_cupertino custom provider.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

patch/stream_targets/custom/{id}

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"stream_target_custom": {"name": "My Updated Custom Stream Target"
}
}

Response samples

application/json

{"stream_target_custom": {"created_at": "2020-01-28T17:16:22.011Z",
"delivery_protocols": ["rtmp"
],
"id": "RMS45lfvx",
"name": "My Updated Custom Stream Target",
"playback_urls": {"rtmp": [{"name": "default",
"url": "rtmp://cp123456.live.edgefcs.net/live/[EVENT]@654321"
}
]
},
"primary_url": "rtmp://p.ep123456.i.akamaientrypoint.net/EntryPoint",
"provider": "rtmp",
"stream_name": "c8467d50@123456",
"updated_at": "2020-01-30T19:46:22.012Z"
}
}

Delete a custom stream target

This operation deletes a custom stream target.

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

Request

path Parameters

required

string

The unique alphanumeric string that identifies the custom stream target.

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

delete/stream_targets/custom/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WV_HOST}/api/v2.0/stream_targets/custom/2adffc17"

Response samples

application/json

{"Example Response 1": {"meta": {"status": 401,
"code": "ERR-401-NoApiKey",
"title": "No API Key Error",
"message": "No API key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 2": {"meta": {"status": 401,
"code": "ERR-401-NoAccessKey",
"title": "No Access Key Error",
"message": "No access key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 3": {"meta": {"status": 401,
"code": "ERR-401-InvalidApiKey",
"title": "Invalid Api Key Error",
"message": "Invalid API key.",
"description": "",
"links": [ ]
}
},
"Example Response 4": {"meta": {"status": 401,
"code": "ERR-401-InvalidAccessKey",
"title": "Invalid Access Key Error",
"message": "Invalid access key.",
"description": "",
"links": [ ]
}
},
"Example Response 5": {"meta": {"status": 401,
"code": "ERR-401-BadAccountStatus",
"title": "Bad Account Status Error",
"message": "Your account's status doesn't allow this action.",
"description": "",
"links": [ ]
}
},
"Example Response 6": {"meta": {"status": 401,
"code": "ERR-401-FeatureNotEnabled",
"title": "Feature Not Enabled Error",
"message": "This feature isn't enabled.",
"description": "",
"links": [ ]
}
},
"Example Response 7": {"meta": {"status": 401,
"code": "ERR-401-TrialExceeded",
"title": "Bad Billing Status Error",
"message": "Your billing status needs attention. You can't start or add live streams until your billing status is updated.",
"description": "",
"links": [ ]
}
},
"Example Response 8": {"meta": {"status": 401,
"code": "ERR-401-ExpiredToken",
"title": "JWT is expired",
"message": "Token has exired.",
"description": "",
"links": [ ]
}
},
"Example Response 9": {"meta": {"status": 401,
"code": "ERR-401-InvalidToken",
"title": "JWT is invalid",
"message": "Token is invalid.",
"description": "",
"links": [ ]
}
}
}

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

Request Body schema: application/json
required

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.
custom_origin_region	string The region where your Wowza Streaming Engine instance is located. Available from version 1.6. Valid values: us - United States eu - Europe asia - Asia sa - South America india - India Example: `"custom_origin_region": "us"`
custom_origin_url	string The Wowza Streaming Engine instance's domain or IP address starting with http:// or https://. Available from version 1.6. Note: You can find the Host - Server address on the home page of Wowza Streaming Engine under Application Connection Settings.
delivery_protocols	Array of strings Specifies the protocols sent to the stream target. Valid values are hls and dash (MPEG-DASH). The default is hls. Available from version 1.7. Note: If you enable more than one protocol, you'll incur egress charges for each protocol you select. See Protect streams for Google Widevine and Microsoft PlayReady devices with EZDRM and the Wowza Video REST API for an example of setting MPEG-DASH as a delivery protocol for digital rights management (DRM) use. Example: See response body sample
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. Example: `"force_ssl_playback": true`
geoblock_enabled	boolean If true, controls access to the stream from specific locations and, optionally, IP addresses. The default is false. Example: `"geoblock_enabled": true`
geoblock_by_location	string Specifies whether to allow or deny access to the stream from specific locations. The default is disabled. Example: `"geoblock_location": "allow"` Enum: "allow" "deny" "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. Example: `"geoblock_country_codes": "CA, DE"`
geoblock_ip_override	string 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. Example: `"geoblock_ip_override": "allow"` Enum: "allow" "deny" "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 up to about 40 IPv4 and IPv6 IP addresses that always allow or deny streaming based on the geoblock_ip_override value. Troubleshooting: The limit of 40 IP addresses is approximate because all the security information (SSL playback, geoblocking countries and IP addresses, referer header, and token auth) count toward an overall metadata limit. If you have fewer than 40 IP addresses and still receive a 422: Invalid Record (Geoblock IP addresses) error, see Geo-block Wowza CDN on Fastly stream targets with the Wowza Video REST API for more ways to lower the character count. Example: `"geoblock_ip_addresses": "77.12.34.567, 78.23.45.678"`
	Array of objects (property) Configures one or more stream target properties. The property configuration consists of a key/value pair and the section of the stream target configuration table the key/value pair is stored in. Available from version 1.7. Example: See response body sample
referer_enabled	boolean If true, controls access to the stream from specific domains. The client or player requesting access to the stream must send the Referer header so the origin of the request can be validated. The default is false. Note: If you change referer_enabled to false after configuring the referer policy, then later re-enable it, you'll need to re-configure the other referer policy values as well. Available from version 1.7. For more information about the Referer header, see the HTTP specification. Example: `"referer_enabled": true`
referer_allow_empty	boolean The Referer header sent by the client or player can be empty and not identify the origin of the request. The default is false when referer_enabled is true. While less secure, if you know you'll have viewers with a client or player that won't send a Referer header, you can specify true to allow an empty Referer header so those viewers can still access the stream. Available from version 1.7. Example: `"referer_allow_empty": true`
referer_policy	string Specifies whether to allow or deny access to the stream from specific domains. The default is allow when referer_enabled is true. Specify the domains to allow or deny in referer_domains. Available from version 1.7. Example: `"referer_policy": "allow"` Enum: "allow" "deny"
referer_domains	string Domains that are either allowed or blocked from accessing the stream. Enter a comma-separated list of domains that are always allowed or denied access based on the referer_policy value. Required when referer_enabled is true. We recommend you enter the simplest form of the domain as possible, but you do need to build out the domain to the level of subdomains you want to allow or deny. You can fully express to the subdomain (mysubdomain.example.com) to specify that single, specific subdomain or you can use a wildcard () to cover all subdomains at a specific level (.example.com). Example: example.com, .example.com, .mysubdomain.example.com If you entered the above example value for referer_domains, and referer_policy is allow, the following domains are allowed access to the stream: https://example.com https://subdomain.example.com, https://subdomain2.example.com, etc. https://subdomainA.mysubdomain.example.com, https://subdomainB.mysubdomain.example.com, etc. Available from version 1.7. Example: `"referer_domains": "example.com, example2.com"`
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. Example: `"token_auth_enabled": true`
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. Example: `"token_auth_shared_secret": "12345678ABCDEF"`
token_auth_playlist_only	boolean If true, Wowza Video 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. Note: If you've enabled MPEG-DASH on your stream target, `token_auth_playlist_only` applies to both the `playlist.m3u8` for HLS and `manifest.mpd` for MPEG-DASH. Example: `"token_auth_playlist_only": true`

Responses

201

Success

Response Schema: application/json

required

object (stream_target_fastly)

created_at	string <date-time> The date and time that the stream target was created.
custom_origin_region	string <string> The region where your Wowza Streaming Engine instance is located. Available from version 1.6.
custom_origin_url	string <string> The Wowza Streaming Engine instance's domain or IP address. Available from version 1.6.
delivery_protocols	Array of strings An array of the delivery protocols available for this stream target. Available from version 1.7.
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 Specifies whether to allow or deny access to the stream from specific locations. The default is disabled. Enum: "allow" "deny" "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 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. Enum: "allow" "deny" "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.
	object Web addresses that the target uses to play streams.
state	string The state of the stream target. Enum: "activated" "archived"
stream_name	string The name of the stream being ingested into the target.
referer_enabled	boolean If true, controls access to the stream from specific domains. The client or player requesting access to the stream must send the Referer header so the origin of the request can be validated. The default is false. Note: If you change referer_enabled to false after configuring the referer policy, then later re-enable it, you'll need to re-configure the other referer policy values as well. Available from version 1.7. For more information about the Referer header, see the HTTP specification.
referer_allow_empty	boolean The Referer header sent by the client or player can be empty and not identify the origin of the request. The default is false when referer_enabled is true. While less secure, if you know you'll have viewers with a client or player that won't send a Referer header, you can specify true to allow an empty Referer header so those viewers can still access the stream. Available from version 1.7.
referer_policy	string Specifies whether to allow or deny access to the stream from specific domains. The default is allow when referer_enabled is true. Specify the domains to allow or deny in referer_domains. Available from version 1.7. Enum: "allow" "deny"
referer_domains	string Domains that are either allowed or blocked from accessing the stream. Enter a comma-separated list of domains that are always allowed or denied access based on the referer_policy value. Required when referer_enabled is true. We recommend you enter the simplest form of the domain as possible, but you do need to build out the domain to the level of subdomains you want to allow or deny. You can fully express to the subdomain (mysubdomain.example.com) to specify that single, specific subdomain or you can use a wildcard () to cover all subdomains at a specific level (.example.com). Example: example.com, .example.com, .mysubdomain.example.com If you entered the above example value for referer_domains, and referer_policy is allow, the following domains are allowed access to the stream: https://example.com https://subdomain.example.com, https://subdomain2.example.com, etc. https://subdomainA.mysubdomain.example.com, https://subdomainB.mysubdomain.example.com, etc. Available from version 1.7.
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 Video 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. Note: If you've enabled MPEG-DASH on your stream target, `token_auth_playlist_only` applies to both the `playlist.m3u8` for HLS and `manifest.mpd` for MPEG-DASH.
updated_at	string <date-time> The date and time that the stream target was updated.

401

Unauthorized

422

Unprocessable Entity

post/stream_targets/fastly

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"stream_target_fastly": {"name": "My Wowza CDN on Fastly Stream Target"
}
}

Response samples

application/json

{"stream_target_fastly": {"id": "abc45lfyz",
"name": "My Wowza CDN on Fastly Stream Target",
"state": "activated",
"stream_name": "9a00105a",
"delivery_protocols": ["hls"
],
"playback_urls": {"hls": [{"name": "default",
"url": "https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8"
}
]
},
"token_auth_enabled": false,
"token_auth_playlist_only": false,
"geoblock_enabled": true,
"geoblock_by_location": "allow",
"geoblock_country_codes": "DE, US",
"geoblock_ip_override": "deny",
"geoblock_ip_addresses": "77.12.34.567, 78.23.45.678",
"referer_enabled": true,
"referer_allow_empty": false,
"referer_policy": "allow",
"referer_domains": "example.com, example2.com",
"force_ssl_playback": false,
"created_at": "2020-01-28T17:16:22.086Z",
"updated_at": "2020-01-30T15:33:43.086Z"
}
}

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.

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

401

Unauthorized

get/stream_targets/fastly

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/stream_targets/fastly"

Response samples

application/json

{"stream_targets_fastly": [{"created_at": "2020-01-28T17:16:22.010Z",
"id": "abc45lfyz",
"name": "My Wowza CDN on Fastly Stream Target",
"updated_at": "2020-01-31T12:37:22.010Z"
},
{"created_at": "2020-01-28T17:16:22.010Z",
"id": "rdm45lxyz",
"name": "My Second Wowza CDN on Fastly Stream Target",
"updated_at": "2020-01-31T14:17:28.010Z"
}
]
}

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.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the stream target.

Responses

200

Success

Response Schema: application/json

required

object (stream_target_fastly)

created_at	string <date-time> The date and time that the stream target was created.
custom_origin_region	string <string> The region where your Wowza Streaming Engine instance is located. Available from version 1.6.
custom_origin_url	string <string> The Wowza Streaming Engine instance's domain or IP address. Available from version 1.6.
delivery_protocols	Array of strings An array of the delivery protocols available for this stream target. Available from version 1.7.
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 Specifies whether to allow or deny access to the stream from specific locations. The default is disabled. Enum: "allow" "deny" "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 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. Enum: "allow" "deny" "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.
	object Web addresses that the target uses to play streams.
state	string The state of the stream target. Enum: "activated" "archived"
stream_name	string The name of the stream being ingested into the target.
referer_enabled	boolean If true, controls access to the stream from specific domains. The client or player requesting access to the stream must send the Referer header so the origin of the request can be validated. The default is false. Note: If you change referer_enabled to false after configuring the referer policy, then later re-enable it, you'll need to re-configure the other referer policy values as well. Available from version 1.7. For more information about the Referer header, see the HTTP specification.
referer_allow_empty	boolean The Referer header sent by the client or player can be empty and not identify the origin of the request. The default is false when referer_enabled is true. While less secure, if you know you'll have viewers with a client or player that won't send a Referer header, you can specify true to allow an empty Referer header so those viewers can still access the stream. Available from version 1.7.
referer_policy	string Specifies whether to allow or deny access to the stream from specific domains. The default is allow when referer_enabled is true. Specify the domains to allow or deny in referer_domains. Available from version 1.7. Enum: "allow" "deny"
referer_domains	string Domains that are either allowed or blocked from accessing the stream. Enter a comma-separated list of domains that are always allowed or denied access based on the referer_policy value. Required when referer_enabled is true. We recommend you enter the simplest form of the domain as possible, but you do need to build out the domain to the level of subdomains you want to allow or deny. You can fully express to the subdomain (mysubdomain.example.com) to specify that single, specific subdomain or you can use a wildcard () to cover all subdomains at a specific level (.example.com). Example: example.com, .example.com, .mysubdomain.example.com If you entered the above example value for referer_domains, and referer_policy is allow, the following domains are allowed access to the stream: https://example.com https://subdomain.example.com, https://subdomain2.example.com, etc. https://subdomainA.mysubdomain.example.com, https://subdomainB.mysubdomain.example.com, etc. Available from version 1.7.
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 Video 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. Note: If you've enabled MPEG-DASH on your stream target, `token_auth_playlist_only` applies to both the `playlist.m3u8` for HLS and `manifest.mpd` for MPEG-DASH.
updated_at	string <date-time> The date and time that the stream target was updated.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/stream_targets/fastly/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/stream_targets/fastly/2adffc17"

Response samples

application/json

{"stream_target_fastly": {"id": "abc45lfyz",
"name": "My Wowza CDN on Fastly Stream Target",
"state": "activated",
"stream_name": "9a00105a",
"delivery_protocols": ["hls"
],
"playback_urls": {"hls": [{"name": "default",
"url": "https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8"
}
]
},
"token_auth_enabled": false,
"token_auth_playlist_only": false,
"geoblock_enabled": true,
"geoblock_by_location": "allow",
"geoblock_country_codes": "DE, US",
"geoblock_ip_override": "deny",
"geoblock_ip_addresses": "77.12.34.567, 78.23.45.678",
"referer_enabled": true,
"referer_allow_empty": false,
"referer_policy": "allow",
"referer_domains": "example.com, example2.com",
"force_ssl_playback": false,
"created_at": "2020-01-28T17:16:22.086Z",
"updated_at": "2020-01-30T15:33:43.086Z"
}
}

Update a Wowza CDN on Fastly stream target

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

Request

path Parameters

required

string

The unique alphanumeric string that identifies the stream target.

Request Body schema: application/json
required

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. Example: `"name": "My Updated Fastly Stream Target"`
custom_origin_region	string The region where your Wowza Streaming Engine instance is located. Available from version 1.6. Valid values: us - United States eu - Europe asia - Asia sa - South America india - India Example: `"custom_origin_region": "us"`
custom_origin_url	string The Wowza Streaming Engine instance's domain or IP address starting with http:// or https://. Available from version 1.6. Note: You can find the Host - Server address on the home page of Wowza Streaming Engine under Application Connection Settings.
delivery_protocols	Array of strings Specifies the protocols sent to the stream target. Valid values are hls and dash (MPEG-DASH). The default is hls. Available from version 1.7. Note: If you enable more than one protocol, you'll incur egress charges for each protocol you select. See Protect streams for Google Widevine and Microsoft PlayReady devices with EZDRM and the Wowza Video REST API for an example of setting MPEG-DASH as a delivery protocol for digital rights management (DRM) use. Example: See response body sample
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. Example: `"force_ssl_playback": true`
geoblock_enabled	boolean If true, controls access to the stream from specific locations and, optionally, IP addresses. The default is false. Example: `"geoblock_enabled": true`
geoblock_by_location	string Specifies whether to allow or deny access to the stream from specific locations. The default is disabled. Example: `"geoblock_location": "allow"` Enum: "allow" "deny" "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. Example: `"geoblock_country_codes": "CA, DE"`
geoblock_ip_override	string 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. Example: `"geoblock_ip_override": "allow"` Enum: "allow" "deny" "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 up to about 40 IPv4 and IPv6 IP addresses that always allow or deny streaming based on the geoblock_ip_override value. Troubleshooting: The limit of 40 IP addresses is approximate because all the security information (SSL playback, geoblocking countries and IP addresses, referer header, and token auth) count toward an overall metadata limit. If you have fewer than 40 IP addresses and still receive a 422: Invalid Record (Geoblock IP addresses) error, see Geo-block Wowza CDN on Fastly stream targets with the Wowza Video REST API for more ways to lower the character count. Example: `"geoblock_ip_addresses": "77.12.34.567, 78.23.45.678"`
	Array of objects (property) Configures one or more stream target properties. The property configuration consists of a key/value pair and the section of the stream target configuration table the key/value pair is stored in. Available from version 1.7. Example: See response body sample
referer_enabled	boolean If true, controls access to the stream from specific domains. The client or player requesting access to the stream must send the Referer header so the origin of the request can be validated. The default is false. Note: If you change referer_enabled to false after configuring the referer policy, then later re-enable it, you'll need to re-configure the other referer policy values as well. Available from version 1.7. For more information about the Referer header, see the HTTP specification. Example: `"referer_enabled": true`
referer_allow_empty	boolean The Referer header sent by the client or player can be empty and not identify the origin of the request. The default is false when referer_enabled is true. While less secure, if you know you'll have viewers with a client or player that won't send a Referer header, you can specify true to allow an empty Referer header so those viewers can still access the stream. Available from version 1.7. Example: `"referer_allow_empty": true`
referer_policy	string Specifies whether to allow or deny access to the stream from specific domains. The default is allow when referer_enabled is true. Specify the domains to allow or deny in referer_domains. Available from version 1.7. Example: `"referer_policy": "allow"` Enum: "allow" "deny"
referer_domains	string Domains that are either allowed or blocked from accessing the stream. Enter a comma-separated list of domains that are always allowed or denied access based on the referer_policy value. Required when referer_enabled is true. We recommend you enter the simplest form of the domain as possible, but you do need to build out the domain to the level of subdomains you want to allow or deny. You can fully express to the subdomain (mysubdomain.example.com) to specify that single, specific subdomain or you can use a wildcard () to cover all subdomains at a specific level (.example.com). Example: example.com, .example.com, .mysubdomain.example.com If you entered the above example value for referer_domains, and referer_policy is allow, the following domains are allowed access to the stream: https://example.com https://subdomain.example.com, https://subdomain2.example.com, etc. https://subdomainA.mysubdomain.example.com, https://subdomainB.mysubdomain.example.com, etc. Available from version 1.7. Example: `"referer_domains": "example.com, example2.com"`
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. Example: `"token_auth_enabled": true`
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. Example: `"token_auth_shared_secret": "12345678ABCDEF"`
token_auth_playlist_only	boolean If true, Wowza Video 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. Note: If you've enabled MPEG-DASH on your stream target, `token_auth_playlist_only` applies to both the `playlist.m3u8` for HLS and `manifest.mpd` for MPEG-DASH. Example: `"token_auth_playlist_only": true`

Responses

200

Success

Response Schema: application/json

required

object (stream_target_fastly)

created_at	string <date-time> The date and time that the stream target was created.
custom_origin_region	string <string> The region where your Wowza Streaming Engine instance is located. Available from version 1.6.
custom_origin_url	string <string> The Wowza Streaming Engine instance's domain or IP address. Available from version 1.6.
delivery_protocols	Array of strings An array of the delivery protocols available for this stream target. Available from version 1.7.
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 Specifies whether to allow or deny access to the stream from specific locations. The default is disabled. Enum: "allow" "deny" "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 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. Enum: "allow" "deny" "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.
	object Web addresses that the target uses to play streams.
referer_enabled	boolean If true, controls access to the stream from specific domains. The client or player requesting access to the stream must send the Referer header so the origin of the request can be validated. The default is false. Note: If you change referer_enabled to false after configuring the referer policy, then later re-enable it, you'll need to re-configure the other referer policy values as well. Available from version 1.7. For more information about the Referer header, see the HTTP specification.
referer_allow_empty	boolean The Referer header sent by the client or player can be empty and not identify the origin of the request. The default is false when referer_enabled is true. While less secure, if you know you'll have viewers with a client or player that won't send a Referer header, you can specify true to allow an empty Referer header so those viewers can still access the stream. Available from version 1.7.
referer_policy	string Specifies whether to allow or deny access to the stream from specific domains. The default is allow when referer_enabled is true. Specify the domains to allow or deny in referer_domains. Available from version 1.7. Enum: "allow" "deny"
referer_domains	string Domains that are either allowed or blocked from accessing the stream. Enter a comma-separated list of domains that are always allowed or denied access based on the referer_policy value. Required when referer_enabled is true. We recommend you enter the simplest form of the domain as possible, but you do need to build out the domain to the level of subdomains you want to allow or deny. You can fully express to the subdomain (mysubdomain.example.com) to specify that single, specific subdomain or you can use a wildcard () to cover all subdomains at a specific level (.example.com). Example: example.com, .example.com, .mysubdomain.example.com If you entered the above example value for referer_domains, and referer_policy is allow, the following domains are allowed access to the stream: https://example.com https://subdomain.example.com, https://subdomain2.example.com, etc. https://subdomainA.mysubdomain.example.com, https://subdomainB.mysubdomain.example.com, etc. Available from version 1.7.
state	string The state of the stream target. Enum: "activated" "archived"
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 Video 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. Note: If you've enabled MPEG-DASH on your stream target, `token_auth_playlist_only` applies to both the `playlist.m3u8` for HLS and `manifest.mpd` for MPEG-DASH.
updated_at	string <date-time> The date and time that the stream target was updated.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

patch/stream_targets/fastly/{id}

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"stream_target_fastly": {"name": "My Updated Wowza CDN on Fastly Stream Target"
}
}

Response samples

application/json

{"stream_target_fastly": {"id": "abc45lfyz",
"name": "My Updated Wowza CDN on Fastly Stream Target",
"state": "activated",
"stream_name": "9a00105a",
"delivery_protocols": ["hls"
],
"playback_urls": {"hls": [{"name": "default",
"url": "https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8"
}
]
},
"token_auth_enabled": false,
"token_auth_playlist_only": false,
"geoblock_enabled": false,
"referer_enabled": false,
"force_ssl_playback": false,
"created_at": "2020-01-28T17:16:22.086Z",
"updated_at": "2020-01-30T18:13:55.087Z"
}
}

Delete a Wowza CDN on Fastly stream target

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

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

Request

path Parameters

required

string

The unique alphanumeric string that identifies the stream target.

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

delete/stream_targets/fastly/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WV_HOST}/api/v2.0/stream_targets/fastly/2adffc17"

Response samples

application/json

{"Example Response 1": {"meta": {"status": 401,
"code": "ERR-401-NoApiKey",
"title": "No API Key Error",
"message": "No API key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 2": {"meta": {"status": 401,
"code": "ERR-401-NoAccessKey",
"title": "No Access Key Error",
"message": "No access key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 3": {"meta": {"status": 401,
"code": "ERR-401-InvalidApiKey",
"title": "Invalid Api Key Error",
"message": "Invalid API key.",
"description": "",
"links": [ ]
}
},
"Example Response 4": {"meta": {"status": 401,
"code": "ERR-401-InvalidAccessKey",
"title": "Invalid Access Key Error",
"message": "Invalid access key.",
"description": "",
"links": [ ]
}
},
"Example Response 5": {"meta": {"status": 401,
"code": "ERR-401-BadAccountStatus",
"title": "Bad Account Status Error",
"message": "Your account's status doesn't allow this action.",
"description": "",
"links": [ ]
}
},
"Example Response 6": {"meta": {"status": 401,
"code": "ERR-401-FeatureNotEnabled",
"title": "Feature Not Enabled Error",
"message": "This feature isn't enabled.",
"description": "",
"links": [ ]
}
},
"Example Response 7": {"meta": {"status": 401,
"code": "ERR-401-TrialExceeded",
"title": "Bad Billing Status Error",
"message": "Your billing status needs attention. You can't start or add live streams until your billing status is updated.",
"description": "",
"links": [ ]
}
},
"Example Response 8": {"meta": {"status": 401,
"code": "ERR-401-ExpiredToken",
"title": "JWT is expired",
"message": "Token has exired.",
"description": "",
"links": [ ]
}
},
"Example Response 9": {"meta": {"status": 401,
"code": "ERR-401-InvalidToken",
"title": "JWT is invalid",
"message": "Token is invalid.",
"description": "",
"links": [ ]
}
}
}

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.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the stream target.

Responses

200

Success

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.
state	string The state of the VOD stream. Enum: "processing" "completed" "failed"
playback_enabled	boolean Specifies whether playback is enabled for the VOD stream. Enum: true false
reason	string The reason that a VOD stream has the state of failed. Only returned when the state is failed.
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.

401

Unauthorized

422

Unprocessable Entity

get/stream_targets/fastly/{id}/vod_streams

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/stream_targets/fastly/2adffc17/vod_streams"

Response samples

application/json

{"vod_streams": [{"id": "wdjfqvsv",
"name": "My VOD Stream 1",
"state": "failed",
"playback_enabled": false,
"created_at": "2020-02-25T17:16:25.849Z",
"updated_at": "2020-01-28T16:06:47.849Z"
},
{"id": "XyxZKqHO",
"name": "My VOD Stream 2",
"state": "completed",
"playback_enabled": true,
"created_at": "2020-01-29T17:16:21.849Z",
"updated_at": "2020-01-31T02:26:05.849Z"
},
{"id": "Pz21DRSt",
"name": "My VOD Stream 3",
"state": "completed",
"playback_enabled": true,
"created_at": "2020-01-29T17:16:21.849Z",
"updated_at": "2020-01-30T18:13:18.849Z"
}
]
}

Regenerate the connection code for any stream target

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

Request

path Parameters

required

string

The unique alphanumeric string that identifies the stream target.

Responses

200

Success

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 Video. The code can be used once and expires 24 hours after it's created.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

put/stream_targets/{id}/regenerate_connection_code

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WV_HOST}/api/v2.0/stream_targets/2adffc17/regenerate_connection_code"

Response samples

application/json

{"stream_target": {"connection_code": "0cd2e8"
}
}

Configure a property for a stream target

This operation configures a property for a stream target. The properties available will depend on the provider you are using and are noted in the key descriptions below. For example, if you are using the provider Wowza CDN on Fastly, look for that in the descriptions.

For a comprehensive resource describing the use of advanced properties, see Set advanced properties with the Wowza Video REST API.

Request

path Parameters

stream_target_id

required

string

The unique alphanumeric string that identifies the stream target.

Request Body schema: application/json
required

Provide the details of the property or properties to configure in the body of the request. You must include either property or properties in the request as the root object.

One of:

required

object (property)

A stream target property. The property configuration consists of a key/value pair and the section of the stream target configuration table the key/value pair is stored in.

key

required

string

The key of the property.

The following table lists the available property keys.

Key	Description
acao	Explicitly specifies the origin that can access the stream. While most streams won't need the origin explicitly set, you might use this property for older players that don't send the Referer header in their stream request. Available on these targets types: Wowza CDN on Fastly
chunkSize	Defines the duration of the time-based audio and video chunks that Wowza Video delivers to the target. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino
convertAMFData	Determines whether Wowza Video converts incoming AMF data into ID3 tags. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino
playlistSeconds	Defines the maximum allowable length of the playlist. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino
playSSL	Determines whether Wowza Video sends the stream from the target to the player by using SSL (HTTPS). Available on these targets types: Custom: akamai_cupertino
sendSSL	Determines whether Wowza Video sends the stream from the transcoder to the target by using SSL (HTTPS). Available on these targets types: Custom: akamai_cupertino
redundantChunklists	Determines whether Wowza Video 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. Available on these targets types: Custom: akamai_cupertino
relativePlaylists	Allows the viewer to watch the stream over HTTP and HTTPS, whichever protocol their browser calls. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino

Enum: "acao" "chunkSize" "convertAMFData" "sendSSL" "playSSL" "playlistSeconds" "redundantChunklists" "relativePlaylists"

section

required

string

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

Section	Valid keys for the section
hls	acao, chunkSize, convertAMFData, and sendSSL
playlist	playSSL, playlistSeconds, redundantChunklists, and relativePlaylists

Enum: "hls" "playlist"

value

required

string

The value of the property.

The following table provides information about valid values for each property key.

Key(s)	Values for the key
acao	Displays as *http://<origin>*
chunkSize	Valid values are the integers 2, 4, 6, 8, and 10.
convertAMFData playSSL sendSSL redundantChunklists relativePlaylists	Valid values are the Booleans true and false.
playlistSeconds	Valid values are any integer between 6 and 28800 (8 hours).

Responses

200

Success

Response Schema: application/json

One of:

required

object (property)

A stream target property. The property configuration consists of a key/value pair and the section of the stream target configuration table the key/value pair is stored in.

key

required

string

The key of the property.

The following table lists the available property keys.

Key	Description
acao	Explicitly specifies the origin that can access the stream. While most streams won't need the origin explicitly set, you might use this property for older players that don't send the Referer header in their stream request. Available on these targets types: Wowza CDN on Fastly
chunkSize	Defines the duration of the time-based audio and video chunks that Wowza Video delivers to the target. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino
convertAMFData	Determines whether Wowza Video converts incoming AMF data into ID3 tags. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino
playlistSeconds	Defines the maximum allowable length of the playlist. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino
playSSL	Determines whether Wowza Video sends the stream from the target to the player by using SSL (HTTPS). Available on these targets types: Custom: akamai_cupertino
sendSSL	Determines whether Wowza Video sends the stream from the transcoder to the target by using SSL (HTTPS). Available on these targets types: Custom: akamai_cupertino
redundantChunklists	Determines whether Wowza Video 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. Available on these targets types: Custom: akamai_cupertino
relativePlaylists	Allows the viewer to watch the stream over HTTP and HTTPS, whichever protocol their browser calls. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino

Enum: "acao" "chunkSize" "convertAMFData" "sendSSL" "playSSL" "playlistSeconds" "redundantChunklists" "relativePlaylists"

section

required

string

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

Section	Valid keys for the section
hls	acao, chunkSize, convertAMFData, and sendSSL
playlist	playSSL, playlistSeconds, redundantChunklists, and relativePlaylists

Enum: "hls" "playlist"

value

required

string

The value of the property.

The following table provides information about valid values for each property key.

Key(s)	Values for the key
acao	Displays as *http://<origin>*
chunkSize	Valid values are the integers 2, 4, 6, 8, and 10.
convertAMFData playSSL sendSSL redundantChunklists relativePlaylists	Valid values are the Booleans true and false.
playlistSeconds	Valid values are any integer between 6 and 28800 (8 hours).

401

Unauthorized

422

Unprocessable Entity

post/stream_targets/{stream_target_id}/properties

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"property": {"key": "chunkSize",
"section": "hls",
"value": 6
}
}

Response samples

application/json

{"property": {"key": "chunkSize",
"section": "hls",
"value": 6
}
}

Fetch all properties of a stream target

This operation shows the details of all of the properties assigned to a specific stream target. The properties returned will depend on the provider you are using and are noted in the key descriptions below.

For a comprehensive resource describing the use of advanced properties, see Set advanced properties with the Wowza Video REST API.

Request

path Parameters

stream_target_id

required

string

The unique alphanumeric string that identifies the stream target.

Responses

200

Success

Response Schema: application/json

required

Array of objects (property)

Array

key

required

string

The key of the property.

The following table lists the available property keys.

Key	Description
acao	Explicitly specifies the origin that can access the stream. While most streams won't need the origin explicitly set, you might use this property for older players that don't send the Referer header in their stream request. Available on these targets types: Wowza CDN on Fastly
chunkSize	Defines the duration of the time-based audio and video chunks that Wowza Video delivers to the target. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino
convertAMFData	Determines whether Wowza Video converts incoming AMF data into ID3 tags. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino
playlistSeconds	Defines the maximum allowable length of the playlist. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino
playSSL	Determines whether Wowza Video sends the stream from the target to the player by using SSL (HTTPS). Available on these targets types: Custom: akamai_cupertino
sendSSL	Determines whether Wowza Video sends the stream from the transcoder to the target by using SSL (HTTPS). Available on these targets types: Custom: akamai_cupertino
redundantChunklists	Determines whether Wowza Video 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. Available on these targets types: Custom: akamai_cupertino
relativePlaylists	Allows the viewer to watch the stream over HTTP and HTTPS, whichever protocol their browser calls. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino

Enum: "acao" "chunkSize" "convertAMFData" "sendSSL" "playSSL" "playlistSeconds" "redundantChunklists" "relativePlaylists"

section

required

string

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

Section	Valid keys for the section
hls	acao, chunkSize, convertAMFData, and sendSSL
playlist	playSSL, playlistSeconds, redundantChunklists, and relativePlaylists

Enum: "hls" "playlist"

value

required

string

The value of the property.

The following table provides information about valid values for each property key.

Key(s)	Values for the key
acao	Displays as *http://<origin>*
chunkSize	Valid values are the integers 2, 4, 6, 8, and 10.
convertAMFData playSSL sendSSL redundantChunklists relativePlaylists	Valid values are the Booleans true and false.
playlistSeconds	Valid values are any integer between 6 and 28800 (8 hours).

401

Unauthorized

422

Unprocessable Entity

get/stream_targets/{stream_target_id}/properties

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/stream_targets/2adffc17/properties"

Response samples

application/json

{"properties": [{"key": "acao",
"section": "hls",
"value": "http://www.example.com"
},
{"key": "chunkSize",
"section": "hls",
"value": 6
},
{"key": "relativePlaylists",
"section": "playlist",
"value": true
}
]
}

Fetch a property of a stream target

This operation shows the details of a specific property assigned to a specific stream target. The properties returned will depend on the provider you are using and are noted in the key descriptions below.

For a comprehensive resource describing the use of advanced properties, see Set advanced properties with the Wowza Video REST API.

Request

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

200

Success

Response Schema: application/json

required

object (property)

A stream target property. The property configuration consists of a key/value pair and the section of the stream target configuration table the key/value pair is stored in.

key

required

string

The key of the property.

The following table lists the available property keys.

Key	Description
acao	Explicitly specifies the origin that can access the stream. While most streams won't need the origin explicitly set, you might use this property for older players that don't send the Referer header in their stream request. Available on these targets types: Wowza CDN on Fastly
chunkSize	Defines the duration of the time-based audio and video chunks that Wowza Video delivers to the target. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino
convertAMFData	Determines whether Wowza Video converts incoming AMF data into ID3 tags. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino
playlistSeconds	Defines the maximum allowable length of the playlist. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino
playSSL	Determines whether Wowza Video sends the stream from the target to the player by using SSL (HTTPS). Available on these targets types: Custom: akamai_cupertino
sendSSL	Determines whether Wowza Video sends the stream from the transcoder to the target by using SSL (HTTPS). Available on these targets types: Custom: akamai_cupertino
redundantChunklists	Determines whether Wowza Video 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. Available on these targets types: Custom: akamai_cupertino
relativePlaylists	Allows the viewer to watch the stream over HTTP and HTTPS, whichever protocol their browser calls. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino

Enum: "acao" "chunkSize" "convertAMFData" "sendSSL" "playSSL" "playlistSeconds" "redundantChunklists" "relativePlaylists"

section

required

string

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

Section	Valid keys for the section
hls	acao, chunkSize, convertAMFData, and sendSSL
playlist	playSSL, playlistSeconds, redundantChunklists, and relativePlaylists

Enum: "hls" "playlist"

value

required

string

The value of the property.

The following table provides information about valid values for each property key.

Key(s)	Values for the key
acao	Displays as *http://<origin>*
chunkSize	Valid values are the integers 2, 4, 6, 8, and 10.
convertAMFData playSSL sendSSL redundantChunklists relativePlaylists	Valid values are the Booleans true and false.
playlistSeconds	Valid values are any integer between 6 and 28800 (8 hours).

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/stream_targets/{stream_target_id}/properties/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/stream_targets/2adffc17/properties/hls-chunkSize"

Response samples

application/json

{"property": {"key": "chunkSize",
"section": "hls",
"value": 6
}
}

Delete a stream target property

This operation removes a property from a stream target.

Request

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

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

delete/stream_targets/{stream_target_id}/properties/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WV_HOST}/api/v2.0/stream_targets/2adffc17/properties/hls-chunkSize"

Response samples

application/json

{"Example Response 1": {"meta": {"status": 401,
"code": "ERR-401-NoApiKey",
"title": "No API Key Error",
"message": "No API key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 2": {"meta": {"status": 401,
"code": "ERR-401-NoAccessKey",
"title": "No Access Key Error",
"message": "No access key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 3": {"meta": {"status": 401,
"code": "ERR-401-InvalidApiKey",
"title": "Invalid Api Key Error",
"message": "Invalid API key.",
"description": "",
"links": [ ]
}
},
"Example Response 4": {"meta": {"status": 401,
"code": "ERR-401-InvalidAccessKey",
"title": "Invalid Access Key Error",
"message": "Invalid access key.",
"description": "",
"links": [ ]
}
},
"Example Response 5": {"meta": {"status": 401,
"code": "ERR-401-BadAccountStatus",
"title": "Bad Account Status Error",
"message": "Your account's status doesn't allow this action.",
"description": "",
"links": [ ]
}
},
"Example Response 6": {"meta": {"status": 401,
"code": "ERR-401-FeatureNotEnabled",
"title": "Feature Not Enabled Error",
"message": "This feature isn't enabled.",
"description": "",
"links": [ ]
}
},
"Example Response 7": {"meta": {"status": 401,
"code": "ERR-401-TrialExceeded",
"title": "Bad Billing Status Error",
"message": "Your billing status needs attention. You can't start or add live streams until your billing status is updated.",
"description": "",
"links": [ ]
}
},
"Example Response 8": {"meta": {"status": 401,
"code": "ERR-401-ExpiredToken",
"title": "JWT is expired",
"message": "Token has exired.",
"description": "",
"links": [ ]
}
},
"Example Response 9": {"meta": {"status": 401,
"code": "ERR-401-InvalidToken",
"title": "JWT is invalid",
"message": "Token is invalid.",
"description": "",
"links": [ ]
}
}
}

Stream Targets

Wowza CDN on Fastly Stream Targets

Custom Stream Targets

Fetch all stream targets

query Parameters

Response Schema: application/json

Create a custom stream target

Request Body schema: application/jsonrequired

Response Schema: application/json

Fetch all custom stream targets

query Parameters

Response Schema: application/json

Fetch a custom stream target

path Parameters

Response Schema: application/json

Update a custom stream target

path Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Delete a custom stream target

path Parameters

Create a Wowza CDN on Fastly stream target

Request Body schema: application/jsonrequired

Response Schema: application/json

Fetch all Wowza CDN on Fastly stream targets

query Parameters

Response Schema: application/json

Fetch a Wowza CDN on Fastly stream target

path Parameters

Response Schema: application/json

Update a Wowza CDN on Fastly stream target

path Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Delete a Wowza CDN on Fastly stream target

path Parameters

Fetch all VOD streams for a Fastly stream target

path Parameters

Response Schema: application/json

Regenerate the connection code for any stream target

path Parameters

Response Schema: application/json

Configure a property for a stream target

path Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Fetch all properties of a stream target

path Parameters

Response Schema: application/json

Fetch a property of a stream target

path Parameters

Response Schema: application/json

Delete a stream target property

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required