Add PHLS Directory - Discontinued

The Flash Media StreamingThis service was discontinued on 5/31/2017. The Flash Media Streaming platform streamed live and on-demand content via a Flash media player over a RTMP-based protocol., HLSAllows the creation of a customized report data., and HDS services were discontinued on May 31, 2017. The information in this article is solely provided as a reference for the migration of automation scripts to a different streaming technology (e.g., Dynamic Cloud Packaging).

Adds a location to which PHLS will be applied to all HLS on-demand content. PHLS is applied recursively on each secured location.

It may take up to 10 minutes for this change to take effect.

Request

A request to add a PHLS directory is described below.

HTTP Method Request URI

POST

https://api.edgecast.com/v2/mcc/customers/AccountNumber/httpstreaming/phlsdirectory

Define the following terms 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

Pass the following request body parameter:

Name Data Type Description

Path

Required

String

Indicates the relative path to the directory for which PHLS will be applied. The starting point for this relative path varies according to the type of origin server that you are trying to secure.

CDN Origin Server:

  • Root Folder: Secure the root folder in your CDN storage account by specifying a forward slash (i.e., /).
  • Subfolder: Secure a different folder by specifying a forward slash and the relative path to that folder (e.g., /Sales/Presentations).

Customer Origin Server:

  • Root Folder: Secure the root folder of a customer origin server by specifying a forward slash, the name of your customer origin server, and then another forward slash (e.g., /MyCustomerOrigin/).
  • Subfolder: Secure a different folder by appending the relative path to the desired folder (e.g., /MyCustomerOrigin/Sales/Presentations).

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

Name Data Type Description

Id

Integer

Indicates the unique ID assigned to the PHLS directory.

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 provided below.

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

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

Accept: application/json

Content-Type: application/json

Host:api.edgecast.com

Content-Length: 38

{
	"Path" : "\/marketing\/limited"
}

A sample JSON response is provided 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: 17

{
	"Id" : 108
}		

Sample Request and Response (XML)

A sample XML request is provided below.

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

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

Accept: application/xml

Content-Type: application/xml

Host:api.edgecast.com

Content-Length: 130

<PHLSDirectoryInput xmlns="http://www.whitecdn.com/schemas/apiservices/">
	<Path>/marketing/limited</Path>
</PHLSDirectoryInput>

A sample XML response is provided below.

HTTP/1.1 200 OK

Cache-Control: private

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

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

Content-Length: 157

<PHLSDirectoryId xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<Id>108</Id>
</PHLSDirectoryId>