Update a stream

put

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

Modifies an existing stream. The request body object must be identical in structure to the Get Stream Details response object. You can edit the name, ingestAccelerated, password, dvrWindow, allowedIps, and additionalEmailIds members. If you try to edit any other member, the API returns a 400 error. If you want to update the HTTP digest authentication username, password, or expiryDate for a live stream, refer to these examples Rotate HTTP digest authentication settings.

Path Params

streamId

integer

required

Unique identifier for each stream.

Query Params

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

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.

backupIngestLocations

object

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

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 CP code provided by Akamai for the VOD origin.

dvrWindow

integer

The length of time the streaming content is available in archive, from 5 to 30 minutes. A 30 minute scrub back window is enabled for all streams.

encoderZone

string

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

events

array of objects

The events and the number of days of data pertaining to these events that 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:

integer

A unique identifier for the stream.

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.

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.

streamAuth

object

Specify details about the stream authentication settings.

streamAuthPrevious

object

Specify 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 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

202

Successful response.

400Invalid input in the request.

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