Adds a stream key that provides authorization for the Dynamic Cloud Packaging streaming service.
A request to add a stream key is described below.
HTTP Method | Request URI |
---|---|
POST |
https://api.edgecast.com/v2/mcc/customers/AccountNumber/httpstreaming/dcp/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 |
---|---|
Required |
|
This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.
Pass the following request body parameters:
Name | Data Type | Description |
---|---|---|
DirPath Required |
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. This stream path must consist of:
Optionally, an asterisk (*), which represents one or more characters, may be appended to the stream name. Do not specify a pattern after an asterisk as it will be ignored. |
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. This key must be 256 alphanumeric characters or less. |
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 parameter:
Name | Data Type | Description |
---|---|---|
DirPath |
String |
Indicates the stream path assigned to the new stream key. |
Id |
Integer |
Indicates the unique system-defined ID assigned to the newly created stream key. |
Key |
String |
Indicates the live authentication key assigned to the new stream key. |
The response body for an unsuccessful request may contain an error parameter that provides additional information.
A sample JSON request is provided below.
POST https://api.edgecast.com/v2/mcc/customers/0001/httpstreaming/dcp/streamkeys HTTP/1.1
Authorization: TOK:12345678-1234-1234-1234-1234567890ab
Accept: application/json
Content-Type: application/json
Host:api.edgecast.com
Content-Length: 69
{ "DirPath" : "myinstance\/livevideos", "Key" : "abcdef123456" }
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: 69
{ "DirPath": "myinstance\/livevideos", "Id": 193950, "Key": "abcdef123456" }