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).
Retrieves a list of customer origin configurations associated with the Flash Media Streaming platform.
A request to retrieve a list of customer origins is described below.
| HTTP Method | Request URI |
|---|---|
|
GET |
https://api.edgecast.com/v2/mcc/customers/AccountNumber/origins/flash |
Define the following variables 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 |
|---|---|
|
Required |
|
This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.
Request body parameters are not required by this endpoint.
The response to the above request includes an HTTP status code, response headers, and a response body.
A status code indicates whether the request was successfully performed.
The response for this endpoint only includes standard HTTP response headers.
The response body for a successful request contains the following response parameters for each customer origin configuration returned by this endpoint:
| Name | Data Type | Description |
|---|---|---|
|
DirectoryName |
String |
Identifies the directory name assigned to the customer origin configuration. This alphanumeric name is appended to the end of the base CDN URL that points to the customer origin server. Example: rtmp://fms.0001.edgecastcdn.net/800001/CustomerOriginThis variable represents the directory name assigned to your customer origin configuration. |
|
HostHeader |
String |
Identifies the value that will be assigned to the Host header for all requests to this customer origin configuration. |
|
HttpFullUrl |
String |
Indicates the CDN URL for RTMP requests to this customer origin server. |
|
HttpHostnames |
Array |
This response parameter contains the hostnames/IP addresses that will handle RTMP requests. |
|
IsPrimary |
Integer |
HttpHostnames array Indicates whether a particular hostname/IP address is the primary one for RTMP requests. Valid values are:
|
|
Name |
String |
HttpHostnames array Reports the URL for the current hostname/IP address. This URL consists of the protocol, hostname/IP address, and the port. |
|
Ordinal |
Integer |
HttpHostnames array Indicates the position in the ordered list for the current hostname/IP address. This position is primarily used by "Primary and Failover" load balancing mode to determine which hostname/IP address will take over when a hostname/IP address higher on the list is unreachable. |
|
HttpLoadBalancing |
String |
Indicates how requests will be load balanced for the specified hostnames/IP addresses. Valid values are:
The load balancing mode indicated for your customer origin configuration is independent from any load balancing configuration that may exist at the origin server. |
|
HttpsFullUrl |
|
This response body parameter is not applicable for the Flash Media Streaming platform and will always return a null value. |
|
HttpsHostnames |
|
This response body parameter is not applicable for the Flash Media Streaming platform and will always return a null value. |
|
HttpsLoadBalancing |
|
This response body parameter is not applicable for the Flash Media Streaming platform and will always return a null value. |
|
Id |
Integer |
Indicates the unique ID assigned to this customer origin configuration. |
|
MediaTypeId |
Integer |
Identifies the platform on which the customer origin configuration resides. This response parameter will always report "2," which is the value assigned to the Flash Media Streaming platform. |
|
ShieldPOPs |
|
This response body parameter is not applicable for the Flash Media Streaming platform and will always return a null value. |
|
UseOriginShield |
|
This response body parameter is not applicable for the Flash Media Streaming platform and will always return a null value. |
|
networkConfiguration |
Integer |
Indicates how hostnames associated with a customer origin configuration will be resolved to an IP address. Valid values are:
|
The response body for an unsuccessful request may contain an error parameter that provides additional information.
A sample JSON request is shown below.
GET https://api.edgecast.com/v2/mcc/customers/0001/origins/flash HTTP/1.1
Authorization: TOK:12345678-1234-1234-1234-1234567890ab
Accept: 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: 483
[{
"DirectoryName" : "videos.example.com",
"HostHeader" : "videos.example.com",
"HttpFullUrl" : "rtmp:\/\/fms.0001.edgecastcdn.net\/800001\/videos.example.com",
"HttpHostnames" : [{
"IsPrimary" : 1,
"Name" : "http:\/\/videos.example.com:80",
"Ordinal" : 0
}
],
"HttpLoadBalancing" : "PF",
"HttpsFullUrl" : null,
"HttpsHostnames" : [],
"HttpsLoadBalancing" : "",
"Id" : 44683,
"MediaTypeId" : 2,
"ShieldPOPs" : [],
"UseOriginShield" : 0,
"networkConfiguration" : 1
}
]
A sample XML request is shown below.
GET https://api.edgecast.com/v2/mcc/customers/0001/origins/flash HTTP/1.1
Authorization: TOK:12345678-1234-1234-1234-1234567890ab
Accept: application/xml
Host:api.edgecast.com
A sample XML response is shown 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: 838
<ArrayOfCustomerOrigin xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<CustomerOrigin>
<DirectoryName>videos.example.com</DirectoryName>
<HostHeader>www.example.com</HostHeader>
<HttpFullUrl>rtmp://fms.0001.edgecastcdn.net/800001/videos.example.com</HttpFullUrl>
<HttpHostnames>
<Hostname>
<IsPrimary>1</IsPrimary>
<Name>http://videos.example.com:80</Name>
<Ordinal>0</Ordinal>
</Hostname>
</HttpHostnames>
<HttpLoadBalancing>PF</HttpLoadBalancing>
<HttpsFullUrl i:nil="true" />
<HttpsHostnames />
<HttpsLoadBalancing />
<Id>44683</Id>
<MediaTypeId>2</MediaTypeId>
<ShieldPOPs />
<UseOriginShield>0</UseOriginShield>
<networkConfiguration>1</networkConfiguration>
</CustomerOrigin>
</ArrayOfCustomerOrigin>