Get 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).

Retrieves the properties associated with a stream key that provides authorization for the following streaming services:

Request

A request to retrieve a stream key is described below.

HTTP Method Request URI

GET

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

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

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.

KeyID

Required

Replace this variable with the unique ID assigned to the stream key whose properties you would like to retrieve.

Use the Get All Stream Keys endpoint to retrieve a list of stream keys and their IDs.

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:

Name Data Type Description

Id

Integer

Reports the unique identifier assigned to the requested stream key configuration.

Key

String

Identifies the live authentication key that may be used to authenticate streams published to the relative path associated with this stream key configuration.

Path

String

Identifies the relative location from the content access point (e.g., /200001/) for which the key associated with this stream key configuration will be valid.

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/fmsliveauth/streamkeys/10 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: 85

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

Sample Request and Response (XML)

A sample XML request is shown below.

GET https://api.edgecast.com/v2/mcc/customers/0001/fmsliveauth/streamkeys/10 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: 186

<FMSLiveAuth xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<Id>10</Id>
	<Key>123456</Key>
	<Path>LiveVideos</Path>
</FMSLiveAuth>