Retrieves stream keys that provide authorization for the Dynamic Cloud Packaging streaming service. The response may be filtered to only return a single stream key.
A request to retrieve a list of stream keys is described below.
HTTP Method | Request URI |
---|---|
GET |
Retrieve all stream keys: https://api.edgecast.com/v2/mcc/customers/AccountNumber/httpstreaming/dcp/streamkeys Retrieve a specific stream key: https://api.edgecast.com/v2/mcc/customers/AccountNumber/httpstreaming/dcp/streamkeys&id=StreamID |
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 |
---|---|
Required |
|
Replace this variable with the system-defined ID associated with the desired stream key. The id query string parameter should only be specified to filter the response to return a single stream key. |
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 stream key returned by this endpoint:
Name | Data Type | Description |
---|---|---|
DirPath |
String |
Identifies a stream by its relative path. The starting point for this relative path is indicated in blue font below. rtmp://fso.oxr.0001.edgecastcdn.net/200001/myinstance/mystream
The stream identified by this parameter will be authorized by the value defined in the Key parameter. |
Id |
Integer |
Reports the unique identifier assigned to a 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. |
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/httpstreaming/dcp/streamkeys 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: 294
[{ "DirPath": "myinstance\/mystream", "Id": 192836, "Key": "123457890abcdefghi" }, { "DirPath": "myinstance\/salesconference", "Id": 192837, "Key": "223457890abcdefghi" }, { "DirPath": "myinstance\/marketingevent", "Id": 192873, "Key": "323457890abcdefghi" } ]