Log in Register

Login to your account

Username *
Password *
Remember Me

Create an account

Fields marked with an asterisk (*) are required.
Name *
Username *
Password *
Verify password *
Email *
Verify email *
Captcha *

 


INDEX

 

getServerInfo

ping

gc

getApps

blockApp

resetApp

getAppStats

getLiveStreams

getLiveStreamStats

recordLiveStream

getVodFiles

getVodFile

deleteVodFile

getUsers

killUser

disconnectUsers

 

 


** securekey : Security key needed to authenticate the command (can be found in reddpanel client -> settings)


 


getServerInfo

 

Request

-> HTTP:

{codecitation class="brush: java; gutter: false;"}

http://localhost:5080/redpanel/admin/getServerInfo?securekey={your-security-key}

{/codecitation}

 

Description:

Retrieves basic information about the server such as red5 version, server id, uptime, available memory, reddpanel version etc. 

 

Availability:

ReddPanel 0.0.2 (version code 2)

 

Parameters:

  • securekey : Security key needed to authenticate the command (can be found in reddpanel client -> settings)

 

Response:

-> HTTP: Call returns JSON formatted response

{codecitation class="brush: java; gutter: false;"}

{  

   "data":{  

      "red5":"Red5 Server 1.0.2",

      "cores":4,

      "totalmemory":144310272,

      "freememory":12400176,

      "maxmemory":1536688128,

      "redpanel":2,

      "serverid":"red5.server",

      "uptime":156906

   },

   "timestamp":1421745910373

 

}

{/codecitation}

 

 


 

ping

 

Request

-> HTTP:

{codecitation class="brush: java; gutter: false;"}

http://localhost:5080/redpanel/admin/ping?securekey={your-security-key}

{/codecitation}

 

Description:

Pings the server via reddpanel and returns. This method may not have any direct implications but can be used to check the running status of the server whenever needed.

 

Availability:

ReddPanel 0.0.2 (version code 2)

 

Parameters:

  • securekey : Security key needed to authenticate the command (can be found in reddpanel client -> settings)
  • app : server side application in context

 

Response:

-> HTTP: Call returns JSON formatted response

{codecitation class="brush: java; gutter: false;"}

{  

   "data":{  

      "invoked":"I am alive @ 2015-01-20 15:04:20.23"

   },

   "timestamp":1421746460231

}

{/codecitation}

 

 


 

gc

 

Request

-> HTTP:

{codecitation class="brush: java; gutter: false;"}

http://localhost:5080/redpanel/admin/gc?securekey={your-security-key}

{/codecitation}

 

Description:

Runs the System.GC() command on Red5 server requesting garbage collection.

 

Availability:

ReddPanel 0.0.2 (version code 2)

 

Parameters:

  • securekey : Security key needed to authenticate the command (can be found in reddpanel client -> settings)

 

Response:

-> HTTP: Call returns JSON formatted response

{codecitation class="brush: java; gutter: false;"}

{  

   "data":{  

      "invoked":"Executed GC @ 2015-01-20 15:08:13.118"

   },

   "timestamp":1421746693348

}

 

{/codecitation}

 

 


 

getApps

 

Request

-> HTTP:

{codecitation class="brush: java; gutter: false;"}

http://localhost:5080/redpanel/admin/getApps?securekey={your-security-key}

{/codecitation}

 

Description:

Retrieves a list of applications available on the red5 server instance.

 

Availability:

ReddPanel 0.0.2 (version code 2)

 

Parameters:

  • securekey : Security key needed to authenticate the command (can be found in reddpanel client -> settings)

 

Response:

-> HTTP: Call returns JSON formatted response

{codecitation class="brush: java; gutter: false;"}

{  

   "data":{  

      "apps":[  

         "syslive"

      ]

   },

   "timestamp":1421754182522

}

 

 

{/codecitation}

 


 

blockApp

 

Request

-> HTTP:

{codecitation class="brush: java; gutter: false;"}

http://localhost:5080/redpanel/admin/blockApp?app={appname}&securekey={your-security-key}

{/codecitation}

 

Description:

Issues a block request on the specified application. This mean users cannot connect to this application anymore.

 

Availability:

ReddPanel 0.0.2 (version code 2)

 

Parameters:

  • securekey : Security key needed to authenticate the command (can be found in reddpanel client -> settings)
  • app : server side application in context

 

Response:

-> HTTP: Call returns JSON formatted response

{codecitation class="brush: java; gutter: false;"}

{  

   "data":{  

   },

   "timestamp":1421754527904

}

 

 

 

{/codecitation}

 

 


 

resetApp

 

Request

-> HTTP:

{codecitation class="brush: java; gutter: false;"}

http://localhost:5080/redpanel/admin/resetApp?app={appname}&securekey={your-security-key}

{/codecitation}

 

Description:

Issues a reset request on the specified application. This is same as reloading the application configurations. It may be helpful to run this command to make the application re-read changed configuration files and settings. Application releases all existing connections before resetting itself.

 

Availability:

ReddPanel 0.0.2 (version code 2)

 

Parameters:

  • securekey : Security key needed to authenticate the command (can be found in reddpanel client -> settings)
  • app : server side application in context

 

Response:

-> HTTP: Call returns JSON formatted response

{codecitation class="brush: java; gutter: false;"}

{  

   "data":{  

   },

   "timestamp":1421754527904

}

 

 

 

 

{/codecitation}

 

 


 

getAppStats

 

Request

-> HTTP:

{codecitation class="brush: java; gutter: false;"}

http://localhost:5080/redpanel/admin/getAppStats?app={appname}&securekey={your-security-key}

{/codecitation}

 

Description:

Retrieves basic application statistics such as total users, active users, bytes sent received etc: 

 

Availability:

ReddPanel 0.0.2 (version code 2)

 

Parameters:

  • securekey : Security key needed to authenticate the command (can be found in reddpanel client -> settings)
  • app : server side application in context

 

Response:

-> HTTP: Call returns JSON formatted response

{codecitation class="brush: java; gutter: false;"}

{  

   "data":{  

      "activeclients":0,

      "bytessent":"0.00",

      "created":1421745821172,

      "bytesreceived":"0.00",

      "totalconnections":0,

      "totalclients":0,

      "activeconnections":0,

      "timestamp":1421754776338

   },

   "timestamp":1421754776342

}

 

 

 

 

 

{/codecitation}

 

 


 

getLiveStreams

 

Request

-> HTTP:

{codecitation class="brush: java; gutter: false;"}

http://localhost:5080/redpanel/admin/getLiveStreams?app={appname}&securekey={your-security-key}

{/codecitation}

 

Description:

Retrieves a list of live streams available in a application at any given time. Thi scommand is meant to be run on live streaming applications only.

 

Availability:

ReddPanel 0.0.2 (version code 2)

 

Parameters:

  • securekey : Security key needed to authenticate the command (can be found in reddpanel client -> settings)
  • app : server side application in context

 

Response:

-> HTTP: Call returns JSON formatted response

{codecitation class="brush: java; gutter: false;"}

{  

   "data":{  

      "streams":[  

         "stream1421754999476"

      ]

   },

   "timestamp":1421755056318

}

 

 

 

 

 

 

{/codecitation}

 

 


 

getLiveStreamStats

 

Request

-> HTTP:

{codecitation class="brush: java; gutter: false;"}

http://localhost:5080/redpanel/admin/getLiveStreamStats?app={appname}&stream={streamname}&securekey={your-security-key}

{/codecitation}

 

Description:

Retrieves the basic statistics associated with a specified live stream such as subscriber count, creation time etc:

 

Availability:

ReddPanel 0.0.2 (version code 2)

 

Parameters:

  • securekey : Security key needed to authenticate the command (can be found in reddpanel client -> settings)
  • app : server side application in context
  • stream : The name of the stream on which data is sought

 

Response:

-> HTTP: Call returns JSON formatted response

{codecitation class="brush: java; gutter: false;"}

{  

   "data":{  

      "stats":{  

         "activesubscribers":1,

         "name":"ce72da89-d8e0-453c-b73a-3fc1b9c52240",

         "totalsubscribers":1,

         "bytesreceived":2276158,

         "id":1,

         "creationtime":1421755050075

      }

   },

   "timestamp":1421755134264

}

 

 

 

 

 

 

 

{/codecitation}

 

 


 

recordLiveStream

[ Available in reddpanel pro only! ]

Request

-> HTTP:

{codecitation class="brush: java; gutter: false;"}

http://localhost:5080/redpanel/admin/recordLiveStream?app={appname}&stream={streamname}&saveas={savename}&append={append}&securekey={your-security-key}

{/codecitation}

 

Description:

Record any live stream arbitrarily within Red5 media server by simply specifying application name, stream name, saveAs name and append flag. This method only starts the recording process. Recording stops automatically on Red5 once the publisher stops publishing the live stream.

 

Availability:

ReddPanel 0.0.2 (version code 2)

 

Parameters:

  • securekey : Security key needed to authenticate the command (can be found in reddpanel client -> settings)
  • app : server side application in context
  • stream : The name of the stream on which data is sought
  • saveas : The filename to be used to record the live stream into
  • append : true / false (specifies whether to record file in append mode or overwrite and create a new file

 

Response:

-> HTTP: Call returns JSON formatted response

{codecitation class="brush: java; gutter: false;"}

{  

   "data":{  

      "status":"Recording @ {saveas}.flv"

   },

   "timestamp":1422059856836

 

}

{/codecitation}

 

 


 

getVodFiles

[ Available in reddpanel pro only! ]

Request

-> HTTP:

{codecitation class="brush: java; gutter: false;"}

http://localhost:5080/redpanel/admin/getVodFiles?app={appname}&securekey={your-security-key}

{/codecitation}

 

Description:

Retrieves list of media files located in the defined stream directory for the given application.

 

Availability:

ReddPanel 0.0.3 (version code 3)

 

Parameters:

  • securekey : Security key needed to authenticate the command (can be found in reddpanel client -> settings)
  • app : server side application in context

 

Response:

-> HTTP: Call returns JSON formatted response

{codecitation class="brush: java; gutter: false;"}

{  

   "data":{  

      "media":[  

         {  

            "size":"26272499",

            "name":"video.mp4"

         }

      ]

   },

   "timestamp":1423227339109

}

 

 

{/codecitation}


 

getVodFile

[ Available in reddpanel pro only! ]

Request

-> HTTP:

{codecitation class="brush: java; gutter: false;"}

http://localhost:5080/redpanel/admin/getVodFile?app={appname}&stream={filename}&securekey={your-security-key}

{/codecitation}

 

Description:

Retrieves stats about the requested media file which is located in the application's defined streams directory

 

Availability:

ReddPanel 0.0.3 (version code 3)

 

Parameters:

  • securekey : Security key needed to authenticate the command (can be found in reddpanel client -> settings)
  • app : server side application in context
  • filename: The name of the file (with extension) on which data is sought

 

Response:

-> HTTP: Call returns JSON formatted response

{codecitation class="brush: java; gutter: false;"}

{  

   "data":{  

      "size":"26272499",

      "lastmodified":"12/27/2014 19:20:59",

      "name":"video.mp4"

   },

   "timestamp":1423227844669

}

{/codecitation}

 


 

deleteVodFile

[ Available in reddpanel pro only! ]

Request

-> HTTP:

{codecitation class="brush: java; gutter: false;"}

http://localhost:5080/redpanel/admin/deleteVodFile?app={appname}&stream={filename}&securekey={your-security-key}

{/codecitation}

 

Description:

Retrieves stats about the requested media file which is located in the application's defined streams directory

 

Availability:

ReddPanel 0.0.3 (version code 3)

 

Parameters:

  • securekey : Security key needed to authenticate the command (can be found in reddpanel client -> settings)
  • app : server side application in context
  • filename: The name of the file (with extension) on which data is sought

 

Response:

-> HTTP: Call returns JSON formatted response

{codecitation class="brush: java; gutter: false;"}

{  

   "data":{  

      "success":true

   },

   "timestamp":1423228236122

}

{/codecitation}

success is true only if operation is successfully

 


 

getUsers

[ Available in reddpanel pro only! ]

Request

-> HTTP:

{codecitation class="brush: java; gutter: false;"}

http://localhost:5080/redpanel/admin/getUsers?app={appname}&securekey={your-security-key}

{/codecitation}

 

Description:

Retrieves the list of all users connected to a given application along with connection stats.

 

Availability:

ReddPanel 0.0.3 (version code 3)

 

Parameters:

  • securekey : Security key needed to authenticate the command (can be found in reddpanel client -> settings)
  • app : server side application in context

 

Response:

-> HTTP: Call returns JSON formatted response

{codecitation class="brush: java; gutter: false;"}

{  

   "data":{  

      "users":[  

         {  

            "ipaddress":"0:0:0:0:0:0:0:1",

            "path":"syslive",

            "port":57400,

            "bytesread":3478,

            "lastping":-1,

            "byteswritten":3354,

            "id":"0",

            "sessionid":"HWGYOVFM2L8KN",

            "creationtime":1423256790959

         }

      ]

   },

   "timestamp":1423256792020

}

{/codecitation}

 


 

killUser

[ Available in reddpanel pro only! ]

Request

-> HTTP:

{codecitation class="brush: java; gutter: false;"}

http://localhost:5080/redpanel/admin/killUser?app={appname}&user={userid}&securekey={your-security-key}

{/codecitation}

 

Description:

Disconnects a given user from a Red5 media server application.

 

Availability:

ReddPanel 0.0.3 (version code 3)

 

Parameters:

  • securekey : Security key needed to authenticate the command (can be found in reddpanel client -> settings)
  • app : server side application in context
  • userid : connection id of the user assigned by red5

 

Response:

-> HTTP: Call returns JSON formatted response

{codecitation class="brush: java; gutter: false;"}

{  

   "data":{  

      "success":true

   },

   "timestamp":1423256969770

}

 

{/codecitation}

success is true only if operation is successfully

 

 


 

disconnectUsers

[ Available in reddpanel pro only! ]

Request

-> HTTP:

{codecitation class="brush: java; gutter: false;"}

http://localhost:5080/redpanel/admin/disconnectUsers?app={appname}&securekey={your-security-key}

{/codecitation}

 

Description:

Disconnects a all user from a Red5 media server application specified by {appname}.

 

Availability:

ReddPanel 0.0.3 (version code 3)

 

Parameters:

  • securekey : Security key needed to authenticate the command (can be found in reddpanel client -> settings)
  • app : server side application in context

 

Response:

-> HTTP: Call returns JSON formatted response

{codecitation class="brush: java; gutter: false;"}

{  

   "data":{  

      "success":true

   },

   "timestamp":1423256969770

}

 

{/codecitation}

 

success is true only if operation is successfully