Control Panel — API documentation

Application

Application object Read-only

Applications represent a common group of streams. Streams on different applications cannot be used together, such as in a switchboard. Applications also control the origin server setting for its streams.

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 Immutable Required

Application Name

The application name must begin with "username-"

Sample value:username-origin

type String Immutable Required

Type of Streaming Application

Enum:origin, chorigin, vod, webrtc

Default:origin

Sample value:vod

flags Integer Immutable

Advanced App Flags, multiple flags can be combined using a logical AND

Flags:

  • 1 - Auto Generated
  • 2 - Legacy Origin
  • 4 - SEVU
  • 8 - Midorigin
  • 16 - Transcode
  • 32 - GPU2
  • 64 - VSO
  • 128 - MultiEdge

Default:0

Sample value:10

origin String Normal

Origin Hostname

Hostnames must resolve to a valid IP address.

Sample value:

origin_id Integer Normal

Origin server id.

Integer

Sample value:1234

backup String Normal

Backup Hostname

Hostnames must resolve to a valid IP address.

Sample value:

backup_id Integer Normal

Backup origin server id.

Integer

Sample value:1234

app_template String Normal

Template for the application

String

Default:default

Sample value:default

config String Normal

Template config settings

String

Default:

Sample value:

playback_hls String Normal

HLS Playback URL

Hostnames must resolve to a valid IP address.

Sample value:

playback_rtmp String Normal

RTMP Playback URL

Hostnames must resolve to a valid IP address.

Sample value:

playback_dash String Normal

DASH Playback URL

Hostnames must resolve to a valid IP address.

Sample value:

usage_app_id Integer Autogenerated

Application Usage ID

Sample value:

origin_debug String Synthetic

Debug URL for encoder connections

Sample value:https://example-origin.secdn.net/debug

playback_debug String Synthetic

Debug URL for clients playing the stream

Sample value:https://example-hls.secdn.net/debug

option:children String

Include child object in results

Default:none

Sample value:streams

type String Immutable

Type of Streaming Application

Enum:origin, chorigin, vod, webrtc

Sample value:vod

flags Integer Immutable

Advanced App Flags, multiple flags can be combined using a logical AND

Flags:

  • 1 - Auto Generated
  • 2 - Legacy Origin
  • 4 - SEVU
  • 8 - Midorigin
  • 16 - Transcode
  • 32 - GPU2
  • 64 - VSO
  • 128 - MultiEdge

Sample value:10

origin String Normal

Origin Hostname

Sample value:

origin_id Integer Normal

Origin server id.

Sample value:1234

backup String Normal

Backup Hostname

Sample value:

backup_id Integer Normal

Backup origin server id.

Sample value:1234

app_template String Normal

Template for the application

Sample value:default

config String Normal

Template config settings

Sample value:

usage_app_id Integer Autogenerated

Application Usage ID

Sample value:

None

Child endpoints

Streams

Live streams

Examples

Get the Apps object with id username-origin.

Example URL

https://api.scaleengine.net/dev/v2/apps/username-origin

Example cURL

curl --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/dev/v2/apps/username-origin

Example request body

None

Example response data

{
    "id": "N/A",
    "cdn_id": "8123",
    "name": "username-origin",
    "type": "vod",
    "flags": "10",
    "origin": "",
    "origin_id": "1234",
    "backup": "",
    "backup_id": "1234",
    "app_template": "default",
    "config": "",
    "playback_hls": "",
    "playback_rtmp": "",
    "playback_dash": "",
    "usage_app_id": "",
    "origin_debug": "https://example-origin.secdn.net/debug",
    "playback_debug": "https://example-hls.secdn.net/debug"
}

This object is read-only and cannot be created.

This object is read-only and cannot be updated.

This object is read-only and cannot be deleted.

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

APP_INVALID

The application name must begin with "username-"

INVALID_ENUM

The value must match one of the predefined values

INVALID_FLAG

The value must match one or more of the predefined flags

HOSTNAME_INVALID

Hostnames must resolve to a valid IP address.