# Create a custom stream target

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

Endpoint: POST /stream_targets/custom
Version: v2.0

## Request fields (application/json):

  - `stream_target_custom` (object, required)
    Example: {"name":"My Custom Stream Target","primary_url":"rtmp://p.ep123456.i.akamaientrypoint.net/EntryPoint","provider":"rtmp","stream_name":"c8467d50@123456"}

  - `stream_target_custom.name` (string, required)
    A descriptive name for the custom stream target. Maximum 255 characters.
    Example: "My Custom Stream Target"

  - `stream_target_custom.primary_url` (string, required)
    The primary RTMP ingest URL. Hostnames can't contain underscores.
    Example: "rtmp://p.ep123456.i.akamaientrypoint.net/EntryPoint"

  - `stream_target_custom.provider` (string, required)
    The CDN for the target.
    Enum: "akamai_cupertino", "rtmp", "rtmps"

  - `stream_target_custom.stream_name` (string, required)
    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: "c8467d50@123456"

  - `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_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"
    Example: "rtmp://b.ep337857.i.akamaientrypoint.net/EntryPoint"

  - `stream_target_custom.playback_urls` (object)
    Web addresses that the target uses to play streams. Available from version 1.7.

Example: See response body sample

  - `stream_target_custom.playback_urls.hls` (string)
    Web address that the target uses to play HLS streams.  The format is a hash where the key is hls and the value is the playback URL. Example: "hls": "http://<domain>/master.m3u8"

  - `stream_target_custom.playback_urls.hds` (string)
    Web address that the target uses to play HDS streams. Not for use with the akamai_cupertino custom provider. The format is a hash where the key is hds and the value is the playback URL. Example: "hds": "http://<domain>/manifest.f4m"

  - `stream_target_custom.playback_urls.rtmp` (string)
    Web address that the target uses to play RTMP streams. The format is a hash where the key is rtmp and the value is the playback URL. Example: "rtmp": "rtmp://cp319499.live.edgefcs.net/live/c9467d50@337857"

  - `stream_target_custom.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"
    Example: "cb1e77e98d"

  - `stream_target_custom.username` (string)
    The username or ID that the target uses for RTMP authentication. Not for use with the akamai_cupertino custom provider.
    Example: "319699"

## Response 201 fields (application/json):

  - `stream_target_custom` (object)
    Example: {"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"}

  - `stream_target_custom.backup_url` (string)
    The backup ingest URL for a custom stream target. Not for use with the akamai_cupertino custom provider.

  - `stream_target_custom.created_at` (string)
    The date and time that the custom stream target was created.
    Example: "2020-01-28T17:16:22.011Z"

  - `stream_target_custom.delivery_protocols` (array)
    An array of the delivery protocols available for this stream target. Available from version 1.7.
    Example: ["rtmp"]

  - `stream_target_custom.id` (string)
    The unique alphanumeric string that identifies the custom stream target.
    Example: "RMS45lfvx"

  - `stream_target_custom.name` (string)
    A descriptive name for the custom stream target. Maximum 255 characters.
    Example: "My Custom Stream Target"

  - `stream_target_custom.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.

  - `stream_target_custom.playback_urls` (object)
    Web addresses that the target uses to play streams. Available from version 1.7.
    Example: {"rtmp":[{"name":"default","url":"rtmp://cp123456.live.edgefcs.net/live/[EVENT]@654321"}]}

  - `stream_target_custom.playback_urls.hls` (array)
    Web address that the target uses to play HLS streams.

  - `stream_target_custom.playback_urls.hls.name` (string)
    The name of the playback URL.
    Example: "default"

  - `stream_target_custom.playback_urls.hls.url` (string)
    The playback URL.

  - `stream_target_custom.playback_urls.hds` (array)
    Web address that the target uses to play HDS streams. Not for use with the akamai_cupertino custom provider.

  - `stream_target_custom.playback_urls.rtmp` (array)
    Web address that the target uses to play RTMP streams.
    Example: [{"name":"default","url":"rtmp://cp123456.live.edgefcs.net/live/[EVENT]@654321"}]

  - `stream_target_custom.primary_url` (string)
    The primary ingest URL of the custom stream target.
    Example: "rtmp://p.ep123456.i.akamaientrypoint.net/EntryPoint"

  - `stream_target_custom.provider` (string)
    The CDN for the target.
    Example: "rtmp"

  - `stream_target_custom.stream_name` (string)
    The name of the stream being ingested into the target.
    Example: "c8467d50@123456"

  - `stream_target_custom.updated_at` (string)
    The date and time that the custom stream target was updated.
    Example: "2020-01-30T19:14:11.011Z"

  - `stream_target_custom.username` (string)
    The username or ID that the target uses for RTMP authentication. Not for use with the akamai_cupertino custom provider.

## Response 401 fields (application/json):

  - `meta` (object, required)

  - `meta.status` (integer)

  - `meta.code` (string)

  - `meta.title` (string)

  - `meta.message` (string)

  - `meta.description` (string)

  - `meta.links` (array)

## Response 422 fields (application/json):

  - `meta` (object, required)

  - `meta.status` (integer)

  - `meta.code` (string)

  - `meta.title` (string)

  - `meta.message` (string)

  - `meta.description` (string)

  - `meta.links` (array)