Create a VOD asset

post

https://{hostname}/live-archive/v1/vod

For beta customers only. Akamai is no longer accepting new members for this beta program. When you enable archiving for an MSL live stream, you can retain it for a maximum of 31 days. To retain archived content beyond 31 days, use this operation to create a separate VOD asset that MSL stores in Akamai NetStorage. You need to set up the desired NetStorage storage group using the Live-to-VOD Export option in Akamai Control Center.

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

URI

string

required

This is the URL for the live stream archive, using the form /{format}/{streamId}/{eventName}/{manifestName}. In it, format is either hls or dash, streamId is the unique, numeric identifier that's been assigned to the stream, eventName is the name of the event that you've assigned to the stream, and manifestName is the manifest filename. For example, /hls/708976/helloworld/master.m3u8 is an HLS master manifest URL and /dash/708976/helloworld/hello.mpd is a DASH manifest URL.

assetId

string

required

This is a unique identifier you set for a VOD asset. Start it with four alphanumeric characters followed by 16 numeric characters.

endTime

integer

required

The Unix epoch timestamp that marks the end time of the VOD clip. The value needs to be greater than the startTime by at least 30 seconds and no more than 43200 seconds, representing the clip's maximum allowed duration of 12 hours. There is a 30 minute latency. So, this needs to be less than the current epoch time by at least 1800 seconds.

maxFileSize

integer

The maximum exported segment size in MB. The default value is 100 MB. This only applies to HLS VOD assets.

preserveKeys

boolean

Defaults to false

When set to true, MSL won't export keys and won't change key metadata in the manifests. When set to false, MSL exports keys and may change metadata in the manifests to accommodate. The default value is false. This only applies to HLS VOD assets.

startTime

integer

required

The Unix epoch timestamp that marks the start time of the VOD clip.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

202The VOD job is successfully created. Returns an export ID (EID).

400The URL is not formed correctly. The POST body is not valid.

403The VOD Management API is not enabled for this stream. The VOD Management API is not enabled globally.

405HTTP method error.

500The CP code or originshield hostname is not available for the stream ID. There is an error initiating the VOD job.