Add Stream Key - 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 stream key that provides authorization for the following streaming services:

Request

A request to add a stream key is described below.

HTTP Method Request URI

POST

https://api.edgecast.com/v2/mcc/customers/AccountNumber/fmsliveauth/streamkeys

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

Pass the following request body parameters:

Name Data Type Description

Key

Required

String

Identifies the live authentication key that may be used to authenticate streams published to the path specified by this stream key configuration.

Key information:

  • Use alphanumeric characters when defining a key.
  • An asterisk that represents one or more characters may be appended to the key.

Path

Required

String

Identifies the relative location for which the specified key will be valid. This relative path starts directly after the content access point (e.g., /200001/).

Valid characters for specifying this location are:

  • Alphanumeric characters
  • Dashes
  • Underscores
  • Slashes

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

Reports the unique number assigned to the newly created stream key.

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/fmsliveauth/streamkeys HTTP/1.1

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

Accept: application/json

Content-Type: application/json

Host:api.edgecast.com

Content-Length: 44

{
	"Key" : "123456",
	"Path" : "LiveVideos"
}

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

{
	"Id" : 15
}

Sample Request and Response (XML)

A sample XML request is provided below.

POST https://api.edgecast.com/v2/mcc/customers/0001/fmsliveauth/streamkeys HTTP/1.1

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

Accept: application/xml

Content-Type: application/xml

Host:api.edgecast.com

Content-Length: 144

<FMSLiveAuthParameter xmlns="http://www.whitecdn.com/schemas/apiservices/">
	<Key>123456</Key>
	<Path>LiveVideos</Path>
</FMSLiveAuthParameter>

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

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