Get All Instances (Dynamic Cloud Packaging)

Retrieves a list of all instances and their configuration.

Request

A request to retrieve instances is described below.

HTTP Method	Request URI
GET	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.

Request Headers

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

Request Body

Request body parameters are not required by this endpoint.

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 for each instance returned by this endpoint:

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 during instance creation/modification, 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.

A sample JSON response is shown below.

[{
		"DvrDuration": 1,
		"Encrypted": false,
		"EncryptedKeyRotation": null,
		"HlsPlaybackUrl": "http:\/\/wpc.0001.edgecastcdn.net\/240001\/myfirstinstance\/<streamName>.m3u8",
		"Id": 752,
		"InstanceName": "myfirstinstance",
		"MpegDashPlaybackUrl": "http:\/\/wpc.0001.edgecastcdn.net\/240001\/myfirstinstance\/<streamName>.mpd",		
		"PublishUrl": "\/200001\/myfirstinstance\/<streamName>?<Live Authentication Key>",
		"SegmentSize": 10,
		"SsaEnabled": false
	}, {
		"DvrDuration": 20,
		"Encrypted": true,
		"EncryptedKeyRotation": null,
		"HlsPlaybackUrl": "http:\/\/wpc.0001.edgecastcdn.net\/240001\/mysecondinstance\/<streamName>.m3u8",				
		"Id": 753,
		"InstanceName": "mysecondinstance",
		"MpegDashPlaybackUrl": "http:\/\/wpc.0001.edgecastcdn.net\/240001\/mysecondinstance\/<streamName>.mpd",
		"PublishUrl": "\/200001\/mysecondinstance\/<streamName>?<Live Authentication Key>",
		"SegmentSize": 10,
		"SsaEnabled": false	
	}
]