Control Panel — API documentation

Please provide a valid credit card using the credit card form on the billing page. Update Card Details

Stream Fetches

Streamfetch object

Stream Fetches represent external streams that are pulled and streamed from your origin.

Descriptions

id Integer Autogenerated

Unique identifier for this object.

Sample value:N/A

cdn_id Integer Autogenerated

The CDN ID that owns this object.

Sample value:8123

stream String Normal Required

Stream Name

May only contain alpha numerical characters, dashes (-), and underscores (_)

Sample value:mystreamname

source_url String Normal Required

URL of the Source stream

RFC 2396 compliant URL

Sample value:rtmp://hostname.com/app/inst/stream

audio_codec String Normal

Audio codec: -1 for none, 0 for copy, or aac

String

Default:0

Sample value:aac

audio_bitrate Integer Normal

Audio bitrate

Range:8000 - 1024000

Sample value:8000

server Integer Normal

Server ID

Integer

Sample value:2

custom_settings Boolean Immutable Required

Custom setttings enabled

Boolean

Default:

Sample value:true

active Boolean Normal Required

Active

Boolean

Default:1

Sample value:true

option:related String

Include related object in results

Default:none

Sample value:streamfetch_servers

type Integer Normal Admin-only

Output type. 1 for RTMP, 2 for HLS

Range:1 - 2

Sample value:1

stream String Normal

Stream Name

Sample value:mystreamname

source_url String Normal

URL of the Source stream

Sample value:rtmp://hostname.com/app/inst/stream

dest_url String Normal Admin-only

URL of the destination stream

Sample value:rtmp://hostname.com/app/inst/stream

video_codec String Normal Admin-only

Video codec: -1 for none, 0 for copy, or aac

Sample value:aac

audio_codec String Normal

Audio codec: -1 for none, 0 for copy, or aac

Sample value:aac

server Integer Normal

Server ID

Sample value:2

custom_settings Boolean Immutable

Custom setttings enabled

Sample value:true

active Boolean Normal

Active

Sample value:true

None

Related endpoints

Streamfetch servers

Lists servers available for streamfetch

Stream

live streams

Examples

Get the Streamfetches object with id .

Example URL

https://api.scaleengine.net/dev/v2/streamfetches/

Example cURL

curl --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/dev/v2/streamfetches/

Example request body

None

Example response data

{
    "id": "N/A",
    "cdn_id": "8123",
    "stream": "mystreamname",
    "source_url": "rtmp://hostname.com/app/inst/stream",
    "audio_codec": "aac",
    "audio_bitrate": "8000",
    "server": "2",
    "custom_settings": "true",
    "active": "true"
}

Create a new Streamfetches object.

Example URL

https://api.scaleengine.net/dev/v2/streamfetches

Example cURL

curl -X PUT --data-binary @/path/to/request/body --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/dev/v2/streamfetches

Example request body

{
    "stream": "mystreamname",
    "source_url": "rtmp://hostname.com/app/inst/stream",
    "audio_codec": "aac",
    "audio_bitrate": "8000",
    "server": "2",
    "custom_settings": "true",
    "active": "true"
}

Example response data

{
    "id": "N/A",
    "cdn_id": "8123",
    "stream": "mystreamname",
    "source_url": "rtmp://hostname.com/app/inst/stream",
    "audio_codec": "aac",
    "audio_bitrate": "8000",
    "server": "2",
    "custom_settings": "true",
    "active": "true"
}

Update the Streamfetches object with id .

Example URL

https://api.scaleengine.net/dev/v2/streamfetches/

Example cURL

curl -X POST --data-binary @/path/to/request/body --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/dev/v2/streamfetches/

Example request body

{
    "stream": "mystreamname",
    "source_url": "rtmp://hostname.com/app/inst/stream",
    "audio_codec": "aac",
    "audio_bitrate": "8000",
    "server": "2",
    "active": "true"
}

Example response data

{
    "id": "N/A",
    "cdn_id": "8123",
    "stream": "mystreamname",
    "source_url": "rtmp://hostname.com/app/inst/stream",
    "audio_codec": "aac",
    "audio_bitrate": "8000",
    "server": "2",
    "custom_settings": "true",
    "active": "true"
}

Delete the Streamfetches object with id .

Example URL

https://api.scaleengine.net/dev/v2/streamfetches/

Example cURL

curl -X DELETE --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/dev/v2/streamfetches/

Example request body


			
			
Example response data


None


			
				


	








	
Errors





	

			

			
				ACCESS_VIOLATION
			
			
You do not have access to modify this field

		

			

			
				REQUIRED_FIELD
			
			
Missing one or more required fields

		

			

			
				TYPE_MISMATCH
			
			
Data type does not conform to required field type

		

			

			
				MAX_LENGTH_EXCEEDED
			
			
The value exceeded maximum length allowed

		

			

			
				STREAM_INVALID
			
			
May only contain alpha numerical characters, dashes (-), and underscores (_)

		

			

			
				URL_INVALID
			
			
RFC 2396 compliant URL

		

			

			
				INVALID_RANGE
			
			
The value must be between the predefined range