Create a stream

post

https://{hostname}/config-media-live/v2/msl-origin/streams

Provisions a new stream. To create an ingest stream using Media Services Live 4, you need to:

Set up an ingest for the stream
Set up an archive for the stream. For details on the types of archive you can specify, see Archive stream members.
Set up Media Services Live origin for the stream.

The process of creating or updating any stream changes its status to PENDING. When all of the steps are complete, the stream status changes to PROVISIONED. If any of the steps fail, the stream status changes to FAILED. It takes two to three hours to provision a stream.

Query Params

cloneInternalSettingsFromStreamId

integer

Defaults to -1

Specifies the stream to clone the internal settings from.

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Encapsulates stream configuration and version information. You can list, create, edit, delete, and get details of streams.

activeArchiveDurationInDays

integer

Specify from 1 to 31 to archive your active content. This option is available only for HLS and DASH streams. It appears if you have MediaServicesLive4::LiveToVOD in your contract. There is no default value.

additionalEmailIds

array of strings

Email addresses for people to receive the stream configuration details and status notifications.

additionalEmailIds

allowedIps

array of strings

The IP addresses for your encoder. You can enter up to 50 IP addresses.

allowedIps

backupDirectConnectSettings

object

Specify details about the backup stream direct connect settings.

backupEncoderZone

string

The geographical location of your backup encoder.

backupIngestLocations

object

Specifies the ingest locations such as countries, states, and cities associated with the backup encoder zone.

backupStorageGroup

object

Specifies the details about the secondary storage group override.

contractId

string

The unique identifier for the contract associated with the stream. The system filters the ingest CP code based on the contract ID that you specify. If you create a NetStorage CP code, it is associated with the same contract as the ingest CP code. If you do not specify a contract ID, the system uses the first valid contract.

cpcode

integer

The Content Provider code (CP code) assigned to the stream. A CP code is a unique identifier for reporting, billing, and monitoring traffic served over the Akamai network. It is supplied to you when you purchase a product, and you need it to activate any associated properties. You can generate additional CP codes, typically to implement more detailed billing and reporting functions and assign to custom properties.

dvrWindow

integer

The length of time the streaming content is available in archive, from 5 to 30 minutes. All streams use a 30-minute scrub back window.

encoderZone

string

The primary encoder's geographical location. Choose an encoder that is close to your location.

events

array of objects

The name of the event you want to purge.

events

format

string

enum

The ingest format for Apple HTTP Live Streaming (HLS), Adobe HTTP Dynamic Streaming (HDS), Dynamic Adaptive Streaming over HTTP (DASH), or Common Media Application Format (CMAF).

Allowed:

groupId

integer

Specify the group ID to assign to the origin.

ingestAccelerated

boolean

Indicates whether to use the Media Services Live Ingest Acceleration feature. The Ingest Acceleration feature improves encoder to Akamai ingest performance and provides more stability and reliability over the first mile. If you select true, enter a password in the Password field. The username is the Media Services Live CP code.

isDedicatedOrigin

boolean

If you use a dedicated origin, the origin shield network uses resource group to identify your company. You can't edit an existing stream to make it dedicated, you can use this option only when you create a new stream.

name

string

The name of the stream. The name can be up to 90 characters long and can include alphanumeric, underscore, and dash characters.

origin

object

The primary Media Services Live origin for the stream.

password

string

Specifies the password for authentication.

primaryDirectConnectSettings

object

Specify details about the primary stream direct connect settings.

primaryIngestLocations

object

Specifies the ingest locations such as countries, states, and cities associated with the primary encoder zone.

storageGroup

object

Specifies the details about the primary storage group override.

streamAuth

object

Specifies details about the stream authentication settings.

streamLevelPurgeDays

integer

Specify the archive duration value to purge the content for all the events. You need this value only when specifying the dvrWindow. You don't need it when specifying activeArchiveDurationInDays.

vodOrigin

object

Enables you to record the video on demand. This option is available only for HLS and DASH streams and applies only when you include the activeArchiveDurationInDays member. You can include it if you have MediaServicesLive4::LiveToVOD or MediaServicesLive4::LiveToVodBeta2 in your contract.

Responses

202Successful response.

400Invalid data input.

429Rate limiting error. The maximum request count for a specific time duration for this resource has been reached. See Rate limiting for more information.