Get Encrypted HLS Directories (Dynamic Cloud Packaging)

Retrieves a list of all encrypted HLS directories. This list may be filtered by ID or by origin type.

Request

A request to retrieve encrypted HLS directories is described below.

HTTP Method	Request URI
GET	Retrieve All Encrypted HLS Directories: https://api.edgecast.com/v2/mcc/customers/AccountNumber/httpstreaming/dcp/vod/ehlsdirectory Retrieve a Filtered List of Encrypted HLS Directories: https://api.edgecast.com/v2/mcc/customers/AccountNumber/httpstreaming/dcp/vod/ehlsdirectory?id=EHLSDirectoryID&originid=OriginTypeID

HTTP Method

Request URI

GET

Retrieve All Encrypted HLS Directories:

https://api.edgecast.com/v2/mcc/customers/AccountNumber/httpstreaming/dcp/vod/ehlsdirectory

Retrieve a Filtered List of Encrypted HLS Directories:

https://api.edgecast.com/v2/mcc/customers/AccountNumber/httpstreaming/dcp/vod/ehlsdirectory?id=EHLSDirectoryID&originid=OriginTypeID

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.
EHLSDirectoryID	Replace this variable with the system-defined ID for the desired encrypted HLS directory. The response will be filtered to only return data for the specified encrypted HLS directory. The id query string parameter should only be specified if you would like to filter the response to a specific encrypted HLS directory. Return all encrypted HLS directories by excluding query string parameters from the request.
OriginTypeID	Replace this variable with one of the following values: 1: Filters the response to only include encrypted HLS directories that have been defined for CDN storage. 2: Filters the response to only include encrypted HLS directories that have been defined for customer origin configurations. The originid query string parameter should only be specified if you would like to filter the response by origin type. Return all encrypted HLS directories by excluding query string parameters from the request.

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.

EHLSDirectoryID

Replace this variable with the system-defined ID for the desired encrypted HLS directory. The response will be filtered to only return data for the specified encrypted HLS directory.

The id query string parameter should only be specified if you would like to filter the response to a specific encrypted HLS directory. Return all encrypted HLS directories by excluding query string parameters from the request.

OriginTypeID

Replace this variable with one of the following values:

1: Filters the response to only include encrypted HLS directories that have been defined for CDN storage.
2: Filters the response to only include encrypted HLS directories that have been defined for customer origin configurations.

The originid query string parameter should only be specified if you would like to filter the response by origin type. Return all encrypted HLS directories by excluding query string parameters from the request.

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 encrypted HLS directory returned by this endpoint:

Name	Data Type	Description
CustomerId Deprecated	Integer	Please ignore this parameter. It is slated to be removed from the response.
Id	Integer	Identifies an encrypted HLS directory configuration by its system-defined ID.
OriginName	String	Identifies the type of origin server to which encryption will be applied. Valid values are: CDN: Represents CDN storage. Customer: Represents customer origin configurations.
OriginTypeId	Integer	Identifies the type of origin server to which encryption will be applied. Valid values are: 1: Represents CDN storage. 2: Represents customer origin configurations.
Path	String	Identifies the directory to which encryption will be applied for on-demand playback via Dynamic Cloud Packaging. Encryption will only be applied to playback requests for content stored in this directory and that are directed at the type of origin server identified by the OriginTypeID element.

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.

GET https://api.edgecast.com/v2/mcc/customers/0001/httpstreaming/dcp/vod/ehlsdirectory HTTP/1.1

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

Accept: application/json

Content-Type: application/json

Host: api.edgecast.com

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: 105

[{
		"Id": 6375,
		"OriginName": "CDN",
		"OriginTypeId": 1,
		"Path": "\/videos"
	}
]