Add Instance (Dynamic Cloud Packaging)

Creates an instance.

Request

A request to add an instance is described below.

HTTP Method	Request URI
POST	https://api.edgecast.com/v2/mcc/customers/AccountNumber/httpstreaming/dcp/live

Define the following variable when submitting the above request:

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3).	Description
AccountNumber Required	Replace this variable with a customer account number. This account number may be found in the upper right-hand corner of the MCC.

Description

AccountNumber

Required

Replace this variable with a customer account number. This account number may be found in the upper right-hand corner of the MCC.

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

Request Body

Pass the following request body parameters:

Name	Data Type	Description
EncryptedKeyRotation	Integer	The Encrypted Key Rotation feature requires activation on your account. Please contact your CDN account manager to activate it. A prerequisite for this capability is the enablement of the Encrypted HLS feature on this instance through the Encrypted parameter. Determines whether the encryption key generated for a live event will be rotated at regular intervals. Valid states: Missing/Null: Omit this parameter or set it to a null value to disable encrypted key rotation. Seconds: Set this parameter to the desired time interval. This time interval must be: Greater than or equal to 10 seconds and less than or equal to 1440 seconds. Specified in multiples of 5 (e.g., 10, 15, 20, etc.) seconds. The Server-Side Archiving feature is incompatible with this feature. Do not enable both features within a single instance. Encryption key rotation may only take place at the start of a new segment. Therefore, the live event's segment size factors into when the encryption key will be rotated. Default Value: null
SsaEnabled	Boolean	SSA requires activation on your account. Please contact your CDN account manager to activate it. Determines whether Server-Side Archiving (SSA) will be enabled for all live streams generated from this instance. The Server-Side Archiving feature is incompatible with the Encrypted HLS feature. Do not enable both features within a single instance. Default Value: False
Encrypted	Boolean	Determines whether the live streams generated for this instance will be secured with encrypted HLS. Valid values are: True: Enabled The Server-Side Archiving feature is incompatible with the Encrypted HLS feature. Do not enable both features within a single instance. False: Disabled Default Value: False
InstanceName Required	String	Assigns a name to the instance. This name will be incorporated into the publishing point and playback URL. Therefore, it should be URL-compatible.
DvrDuration	Integer	Determines the length, in minutes, of the DVR window. The length of this DVR window may be set from 5 to 180 minutes (i.e., 3 hours). Default Value: 1 minute
SegmentSize Required	Integer	Determines the size, in seconds, of the segments that will be generated for this instance. Segment size may be set from 1 to 20 seconds. The recommended value for this setting is 10 seconds.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request contains the following response parameters:

Name	Data Type	Description
DvrDuration	Integer	Indicates the length, in minutes, of the DVR window. The length of this DVR window may be set from 5 to 180 minutes (i.e., 3 hours). If a DVR window was not specified in the request, then this parameter will report a default duration of 1 minute.
Encrypted	Boolean	Indicates whether the live streams generated for this instance will be secured with encrypted HLS.
EncryptedKeyRotation	Integer	Indicates the interval, in seconds, at which the encryption key generated for the live event will be rotated. Encryption key rotation may only take place at the start of a new segment. Therefore, the live event's segment size factors into when the encryption key will be rotated. A null value indicates that encrypted key rotation has been disabled.
HlsPlaybackUrl	String	Indicates the instance's HLS playback URL. Syntax: http:\/\/wpc.ANThis term represents a customer account number. This account number may be found in the upper right-hand corner of the MCC..edgecastcdn.net\/24ANThis term represents a customer account number. This account number may be found in the upper right-hand corner of the MCC.\/InstanceName\/<streamName>.m3u8
Id	Integer	Indicates the unique system-defined ID assigned to the instance.
InstanceName	String	Identifies the instance by its name.
MpegDashPlaybackUrl	String	Indicates the instance's MPEG-DASH playback URL. Syntax: http:\/\/wpc.ANThis term represents a customer account number. This account number may be found in the upper right-hand corner of the MCC..edgecastcdn.net\/24ANThis term represents a customer account number. This account number may be found in the upper right-hand corner of the MCC.\/InstanceName\/<streamName>.mpd
PublishUrl	String	Indicates the publishing point's relative path followed by syntax information on how to authorize a stream. Syntax: \/20ANThis term represents a customer account number. This account number may be found in the upper right-hand corner of the MCC.\/InstanceName\/<streamName>?<Live Authentication Key>
SegmentSize	Integer	Indicates the size, in seconds, of the segments that will be generated for this instance.
SsaEnabled	Boolean	Indicates whether Server-Side Archiving (SSA) has been enabled on this instance. SSA requires activation on your account. Please contact your CDN account manager to activate it.

Errors

The response body for an unsuccessful request may contain an error parameter that provides additional information.

View common error messages.

Sample Request and Response (JSON)

A sample JSON request is shown below.

POST https://api.edgecast.com/v2/mcc/customers/0001/httpstreaming/dcp/live HTTP/1.1

Authorization: TOK:12345678-1234-1234-1234-1234567890ab

Accept: application/json

Content-Type: application/json

Host: api.edgecast.com

Content-Length: 61

{
	"InstanceName": "myinstance",
	"SegmentSize": 10
}

A sample JSON response is shown below.

HTTP/1.1 200 OK

Cache-Control: private

Content-Type: application/json; charset=utf-8

Date: Thu, 15 Apr 2021 12:00:00 GMT

Content-Length: 431

{
	"DvrDuration": null,
	"Encrypted": false,	
	"EncryptedKeyRotation": null,
	"HlsPlaybackUrl": "http:\/\/wpc.0001.edgecastcdn.net\/240001\/myinstance\/<streamName>.m3u8",
	"Id": 1317,
	"InstanceName": "myinstance",
	"MpegDashPlaybackUrl": "http:\/\/wpc.0001.edgecastcdn.net\/240001\/myinstance\/<streamName>.mpd",
	"PublishUrl": "\/200001\/myinstance\/<streamName>?<Live Authentication Key>",
	"SegmentSize": 10,
	"SsaEnabled": false
}