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 August 31, 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)

Request samples

Shell
JavaScript

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

Response samples

200
401

Content type

application/json

{"stream_targets": [{"created_at": "2020-01-29T17:16:22.007Z",
"id": "qvvjyjjk",
"name": "My RTMP Stream Target",
"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",
"type": "custom",
"updated_at": "2020-01-31T11:02:53.007Z"
},
{"created_at": "2020-01-28T17:16:22.007Z",
"id": "abcmlh3v",
"name": "My Ultra Low Latency Stream Target",
"type": "ull",
"updated_at": "2020-01-31T07:03:27.007Z"
}
]
}

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)

Responses

Response Schema: application/json

object (stream_target_custom)

Request samples

Payload
Shell
JavaScript

Content type

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

201
401
422

Content type

application/json

{"stream_target_custom": {"created_at": "2020-01-28T17:16:22.011Z",
"id": "RMS45lfvx",
"name": "My Custom Stream Target",
"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.

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)

Request samples

Shell
JavaScript

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

Response samples

200
401

Content type

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.

path Parameters

id

required

string

The unique alphanumeric string that identifies the custom stream target.

Responses

Response Schema: application/json

object (stream_target_custom)

Request samples

Shell
JavaScript

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

Response samples

200
401
403
404
410

Content type

application/json

{"stream_target_custom": {"created_at": "2020-01-28T17:16:22.011Z",
"id": "RMS45lfvx",
"name": "My Custom Stream Target",
"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.

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)

Responses

Response Schema: application/json

object (stream_target_custom)

Request samples

Payload
Shell
JavaScript

Content type

application/json

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

Response samples

Content type

application/json

{"stream_target_custom": {"created_at": "2020-01-28T17:16:22.011Z",
"id": "RMS45lfvx",
"name": "My Updated Custom Stream Target",
"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.

path Parameters

id

required

string

The unique alphanumeric string that identifies the custom stream target.

Responses

Request samples

Shell
JavaScript

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

Response samples

401
403
404
410
422

Content type

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": [ ]
}
}
}

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)

Responses

Response Schema: application/json

required

object (stream_target_fastly)

Request samples

Payload
Shell
JavaScript

Content type

application/json

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

Response samples

201
401
422

Content type

application/json

{"stream_target_fastly": {"id": "abc45lfyz",
"name": "My Wowza CDN on Fastly Stream Target",
"state": "activated",
"stream_name": "9a00105a",
"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",
"geblock_ip_addresses": "77.12.34.567, 78.23.45.678",
"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.

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)

Request samples

Shell
JavaScript

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

Response samples

200
401

Content type

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.

path Parameters

id

required

string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json

required

object (stream_target_fastly)

Request samples

Shell
JavaScript

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

Response samples

200
401
403
404
410

Content type

application/json

{"stream_target_fastly": {"id": "abc45lfyz",
"name": "My Wowza CDN on Fastly Stream Target",
"state": "activated",
"stream_name": "9a00105a",
"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",
"geblock_ip_addresses": "77.12.34.567, 78.23.45.678",
"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.

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)

Responses

Response Schema: application/json

required

object (stream_target_fastly)

Request samples

Payload
Shell
JavaScript

Content type

application/json

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

Response samples

Content type

application/json

{"stream_target_fastly": {"id": "abc45lfyz",
"name": "My Updated Wowza CDN on Fastly Stream Target",
"state": "activated",
"stream_name": "9a00105a",
"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,
"geoblock_by_location": "disabled",
"geoblock_ip_override": "disabled",
"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.

path Parameters

id

required

string

The unique alphanumeric string that identifies the stream target.

Responses

Request samples

Shell
JavaScript

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

Response samples

401
403
404
410
422

Content type

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": [ ]
}
}
}

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)

Request samples

Shell
JavaScript

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

Response samples

200
401
422

Content type

application/json

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

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 August 31, 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)

Responses

Response Schema: application/json

required

object (stream_target_ull)

Request samples

Payload
Shell
JavaScript

Content type

application/json

{"stream_target_ull": {"name": "My first Ultra Low Latency Stream Target",
"source_delivery_method": "pull",
"source_url": "rtsp://10.1.2.3/live/mystream"
}
}

Response samples

201
401
422

Content type

application/json

{"stream_target_ull": {"connection_code": "54ddf5",
"connection_code_expires_at": "2020-02-01T17:16:22.011Z",
"created_at": "2020-01-28T17:16:22.011Z",
"enabled": true,
"enabled_hls": true,
"id": "P3MRRlfvx",
"name": "My Ultra Low Latency Push Stream Target",
"playback_urls": {"ws": ["ws://edge.cdn.wowza.com/live/_definst_/0I0q1bjZhRzZtfSdv4TpCnlmwQT16239/stream.ws",
"wss://edge.cdn.wowza.com/live/_definst_/0I0q1bjZhRzZtfSdv4TpCnlmwQT16239/stream.ws"
],
"wowz": ["wowz://edge.cdn.wowza.com/live/_definst_/0I0q1bjZhRzZtfSdv4TpCnlmwQT16239",
"wowzs://edge.cdn.wowza.com/live/_definst_/0I0q1bjZhRzZtfSdv4TpCnlmwQT16239"
],
"hls": ["https://wowzaqainjest9-i.akamaihd.net/hls/live/268548/0I0q1bjZhRzZtfSdv4TpCnlmwQT16239/playlist.m3u8"
]
},
"primary_url": "rtmp://origin.cdn.wowza.com:1935/live/0I0q1bjZhRzZtfSdv4TpCnlmwQT16239",
"source_delivery_method": "push",
"state": "stopped",
"stream_name": "0I0q1bjZhRzZtfSdv4TpCnlmwQT16239",
"updated_at": "2020-01-30T18:46:06.011Z"
}
}

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 August 31, 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)

Request samples

Shell
JavaScript

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

Response samples

200
401

Content type

application/json

{"stream_targets_ull": [{"created_at": "2020-01-28T17:16:22.008Z",
"id": "K3MRRlfvx",
"name": "My Wowza Ultra Low Latency Pull Stream Target",
"updated_at": "2020-01-31T03:11:06.008Z"
},
{"created_at": "2020-01-28T17:16:22.008Z",
"id": "P3MRRlfvx",
"name": "My Wowza Ultra Low Latency Push Stream Target",
"updated_at": "2020-01-31T02:57:41.008Z"
}
]
}

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 August 31, 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)

Request samples

Shell
JavaScript

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

Response samples

200
401

Content type

application/json

{"stream_targets_ull": [{"created_at": "2020-01-28T17:16:22.008Z",
"id": "K3MRRlfvx",
"name": "My Wowza Ultra Low Latency Pull Stream Target",
"updated_at": "2020-01-31T03:11:06.008Z"
},
{"created_at": "2020-01-28T17:16:22.008Z",
"id": "P3MRRlfvx",
"name": "My Wowza Ultra Low Latency Push Stream Target",
"updated_at": "2020-01-31T02:57:41.008Z"
}
]
}

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 August 31, 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)

Request samples

Shell
JavaScript

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

Response samples

200
401
403
404
410

Content type

application/json

{"stream_target_ull": {"connection_code": "54ddf5",
"connection_code_expires_at": "2020-02-01T17:16:22.011Z",
"created_at": "2020-01-28T17:16:22.011Z",
"enabled": true,
"enabled_hls": true,
"id": "P3MRRlfvx",
"name": "My Ultra Low Latency Push Stream Target",
"playback_urls": {"ws": ["ws://edge.cdn.wowza.com/live/_definst_/0I0q1bjZhRzZtfSdv4TpCnlmwQT16239/stream.ws",
"wss://edge.cdn.wowza.com/live/_definst_/0I0q1bjZhRzZtfSdv4TpCnlmwQT16239/stream.ws"
],
"wowz": ["wowz://edge.cdn.wowza.com/live/_definst_/0I0q1bjZhRzZtfSdv4TpCnlmwQT16239",
"wowzs://edge.cdn.wowza.com/live/_definst_/0I0q1bjZhRzZtfSdv4TpCnlmwQT16239"
],
"hls": ["https://wowzaqainjest9-i.akamaihd.net/hls/live/268548/0I0q1bjZhRzZtfSdv4TpCnlmwQT16239/playlist.m3u8"
]
},
"primary_url": "rtmp://origin.cdn.wowza.com:1935/live/0I0q1bjZhRzZtfSdv4TpCnlmwQT16239",
"source_delivery_method": "push",
"state": "stopped",
"stream_name": "0I0q1bjZhRzZtfSdv4TpCnlmwQT16239",
"updated_at": "2020-01-30T18:46:06.011Z"
}
}

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 August 31, 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)

Responses

Response Schema: application/json

required

object (stream_target_ull)

Request samples

Payload
Shell
JavaScript

Content type

application/json

{"stream_target_ull": {"name": "My Updated Ultra Low Latency Stream Target"
}
}

Response samples

Content type

application/json

{"stream_target_ull": {"created_at": "2020-01-28T17:16:22.011Z",
"enabled": true,
"enable_hls": false,
"id": "453Dlfvx",
"name": "My Updated Ultra Low Latency Stream Target",
"playback_urls": {"ws": ["ws://edge.cdn.wowza.com/live/_definst_/0I0q1bjZhRzZtfSdv4TpCnlmwQT16236/stream.ws",
"wss://edge.cdn.wowza.com/live/_definst_/0I0q1bjZhRzZtfSdv4TpCnlmwQT16236/stream.ws"
],
"wowz": ["wowz://edge.cdn.wowza.com/live/_definst_/0I0q1bjZhRzZtfSdv4TpCnlmwQT16236",
"wowzs://edge.cdn.wowza.com/live/_definst_/0I0q1bjZhRzZtfSdv4TpCnlmwQT16236"
]
},
"source_delivery_method": "pull",
"source_url": "rtsp://10.1.2.3/live/mystream",
"state": "stopped",
"updated_at": "2020-01-31T15:36:27.011Z"
}
}

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 August 31, 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

Shell
JavaScript

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

Response samples

401
403
404
410
422

Content type

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": [ ]
}
}
}

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)

Responses

Response Schema: application/json

required

object (stream_target_akamai)

Request samples

Payload
Shell
JavaScript

Content type

application/json

{"stream_target_akamai": {"name": "My Wowza Stream Target",
"provider": "akamai_cupertino"
}
}

Response samples

201
401
422

Content type

application/json

{"stream_target_akamai": {"created_at": "2020-01-28T17:16:22.086Z",
"id": "ABC45lfyz",
"name": "My Wowza Stream Target",
"provider": "akamai_cupertino",
"use_secure_ingest": false,
"use_cors": false,
"stream_name": "9a00105a",
"primary_url": "http://post.wowzasandbox3-i.akamaihd.net/252232/9a00105a",
"hls_playback_url": "https://wowzasandbox3-i.akamaihd.net/hls/live/252232/9a00105a/playlist.m3u8",
"connection_code": "456fcc",
"connection_code_expires_at": "2020-02-01T17:16:22.086Z",
"updated_at": "2020-01-31T05:08:12.086Z"
}
}

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)

Request samples

Shell
JavaScript

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

Response samples

200
401

Content type

application/json

{"stream_targets_akamai": [{"created_at": "2020-01-28T17:16:22.009Z",
"id": "ABC45lfyz",
"name": "My Wowza Stream Target",
"updated_at": "2020-01-30T20:12:11.010Z"
},
{"created_at": "2020-01-28T17:16:22.010Z",
"id": "RDM45lxyz",
"name": "My Second Wowza Stream Target",
"updated_at": "2020-01-30T15:24:23.010Z"
}
]
}

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)

Request samples

Shell
JavaScript

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

Response samples

200
401
403
404
410

Content type

application/json

{"stream_target_akamai": {"created_at": "2020-01-28T17:16:22.086Z",
"id": "ABC45lfyz",
"name": "My Wowza Stream Target",
"provider": "akamai_cupertino",
"use_secure_ingest": false,
"use_cors": false,
"stream_name": "9a00105a",
"primary_url": "http://post.wowzasandbox3-i.akamaihd.net/252232/9a00105a",
"hls_playback_url": "https://wowzasandbox3-i.akamaihd.net/hls/live/252232/9a00105a/playlist.m3u8",
"connection_code": "456fcc",
"connection_code_expires_at": "2020-02-01T17:16:22.086Z",
"updated_at": "2020-01-31T05:08:12.086Z"
}
}

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)

Responses

Response Schema: application/json

required

object (stream_target_akamai)

Request samples

Payload
Shell
JavaScript

Content type

application/json

{"stream_target_akamai": {"name": "My Updated Wowza Stream Target"
}
}

Response samples

Content type

application/json

{"stream_target_akamai": {"created_at": "2020-01-28T17:16:22.086Z",
"id": "ABC45lfyz",
"name": "My Updated Wowza Stream Target",
"provider": "akamai_cupertino",
"use_secure_ingest": false,
"use_cors": false,
"stream_name": "9a00105a",
"primary_url": "http://post.wowzasandbox3-i.akamaihd.net/252232/9a00105a",
"hls_playback_url": "https://wowzasandbox3-i.akamaihd.net/hls/live/252232/9a00105a/playlist.m3u8",
"connection_code": "456fcc",
"connection_code_expires_at": "2020-02-01T17:16:22.086Z",
"updated_at": "2020-01-31T13:04:44.086Z"
}
}

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

Shell
JavaScript

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

Response samples

401
403
404
410
422

Content type

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": [ ]
}
}
}

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)

Request samples

Shell
JavaScript

// 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/v1.6/stream_targets/2adffc17/regenerate_connection_code"

Response samples

Content type

application/json

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

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)

Responses

Response Schema: application/json

required

object (stream_target_property)

Request samples

Payload
Shell
JavaScript

Content type

application/json

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

Response samples

200
401
422

Content type

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

Request samples

Shell
JavaScript

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

Response samples

200
401
422

Content type

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

Request samples

Shell
JavaScript

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

Response samples

200
401
403
404
410

Content type

application/json

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

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

Shell
JavaScript

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

Response samples

401
403
404
410
422

Content type

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": [ ]
}
}
}

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

Shell
JavaScript

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

Response samples

200
401
403
404
410

Content type

application/json

{"stream_target": {"id": "abcd1234",
"metrics": {"average_total_connections": 10,
"minimum_total_connections": 0,
"maximum_total_connections": 20,
"new_connections": 2,
"dropped_connections": 0,
"average_bytes_in": 456789.123,
"created_at": "2017-08-09T16:18:26.000Z"
}
}
}

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

Shell
JavaScript

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

Response samples

200
401
403
404
410

Content type

application/json

{"stream_target": {"id": "abcd1234",
"interval": "10m",
"metrics": [{"average_total_connections": 10.1,
"minimum_total_connections": 0,
"maximum_total_connections": 20,
"new_connections": 8,
"dropped_connections": 3,
"average_bytes_in": 456789.123,
"created_at": "2017-08-09T16:19:17.000Z"
},
{"average_total_connections": 5.25,
"minimum_total_connections": 0,
"maximum_total_connections": 10,
"new_connections": 7,
"dropped_connections": 2,
"average_bytes_in": 456789.123,
"created_at": "2017-08-09T16:19:07.000Z"
},
{"average_total_connections": 0,
"minimum_total_connections": 0,
"maximum_total_connections": 0,
"new_connections": 0,
"dropped_connections": 0,
"average_bytes_in": 456789.123,
"created_at": "2017-08-09T16:18:57.000Z"
}
]
}
}