Control Panel — API documentation

Pushes

Pushes object

Pushes are configurations for push publishing to another ingest point. Enter the endpoint as a single URL, if you were provided a URL and stream key, enter it as URL/KEY.

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

name String Normal Required

Name of the push entry

String

Default:

Sample value:mypush

stream String Normal

Stream Name

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

Sample value:mystreamname

service String Normal Required

Name of the service where the stream is being pushed.

Enum:rtmp, facebook, youtube, twitch, kick, instagram, tiktok, hls

Default:

Sample value:rtmp

url String Normal

Destination url

Default:

Sample value:rtmp://host/app/stream

autopush Boolean Normal

Start pushing stream on publish.

Boolean

Default:

Sample value:1

created String Autogenerated

Date and time object was created.

Default:

Sample value:2019-12-23 23:59:59

last_update String Autogenerated

Date and time object was last updated.

Default:

Sample value:2019-12-23 23:59:59

None
None
None

Examples

Get the Pushes object with id .

Example URL

https://api.scaleengine.net/v2/pushes/

Example cURL

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

Example request body

None

Example response data

{
    "id": "N/A",
    "cdn_id": "8123",
    "name": "mypush",
    "stream": "mystreamname",
    "service": "rtmp",
    "url": "rtmp://host/app/stream",
    "autopush": true,
    "created": "2019-12-23 23:59:59",
    "last_update": "2019-12-23 23:59:59"
}

Create a new Pushes object.

Example URL

https://api.scaleengine.net/v2/pushes

Example cURL

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

Example request body

{
    "name": "mypush",
    "stream": "mystreamname",
    "service": "rtmp",
    "url": "rtmp://host/app/stream",
    "autopush": true
}

Example response data

{
    "id": "N/A",
    "cdn_id": "8123",
    "name": "mypush",
    "stream": "mystreamname",
    "service": "rtmp",
    "url": "rtmp://host/app/stream",
    "autopush": true,
    "created": "2019-12-23 23:59:59",
    "last_update": "2019-12-23 23:59:59"
}

Update the Pushes object with id .

Example URL

https://api.scaleengine.net/v2/pushes/

Example cURL

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

Example request body

{
    "name": "mypush",
    "stream": "mystreamname",
    "service": "rtmp",
    "url": "rtmp://host/app/stream",
    "autopush": true
}

Example response data

{
    "id": "N/A",
    "cdn_id": "8123",
    "name": "mypush",
    "stream": "mystreamname",
    "service": "rtmp",
    "url": "rtmp://host/app/stream",
    "autopush": true,
    "created": "2019-12-23 23:59:59",
    "last_update": "2019-12-23 23:59:59"
}

Delete the Pushes object with id .

Example URL

https://api.scaleengine.net/v2/pushes/

Example cURL

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

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 (_)

		

			

			
				INVALID_ENUM
			
			
The value must match one of the predefined values